View Javadoc

1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  
28  package org.apache.http.message;
29  
30  import java.io.Serializable;
31  
32  import org.apache.http.ProtocolVersion;
33  import org.apache.http.StatusLine;
34  import org.apache.http.annotation.ThreadingBehavior;
35  import org.apache.http.annotation.Contract;
36  import org.apache.http.util.Args;
37  
38  /**
39   * Basic implementation of {@link StatusLine}
40   *
41   * @since 4.0
42   */
43  @Contract(threading = ThreadingBehavior.IMMUTABLE)
44  public class BasicStatusLine implements StatusLine, Cloneable, Serializable {
45  
46      private static final long serialVersionUID = -2443303766890459269L;
47  
48      // ----------------------------------------------------- Instance Variables
49  
50      /** The protocol version. */
51      private final ProtocolVersion protoVersion;
52  
53      /** The status code. */
54      private final int statusCode;
55  
56      /** The reason phrase. */
57      private final String reasonPhrase;
58  
59      // ----------------------------------------------------------- Constructors
60      /**
61       * Creates a new status line with the given version, status, and reason.
62       *
63       * @param version           the protocol version of the response
64       * @param statusCode        the status code of the response
65       * @param reasonPhrase      the reason phrase to the status code, or
66       *                          {@code null}
67       */
68      public BasicStatusLine(final ProtocolVersion version, final int statusCode,
69                             final String reasonPhrase) {
70          super();
71          this.protoVersion = Args.notNull(version, "Version");
72          this.statusCode = Args.notNegative(statusCode, "Status code");
73          this.reasonPhrase = reasonPhrase;
74      }
75  
76      // --------------------------------------------------------- Public Methods
77  
78      @Override
79      public int getStatusCode() {
80          return this.statusCode;
81      }
82  
83      @Override
84      public ProtocolVersion getProtocolVersion() {
85          return this.protoVersion;
86      }
87  
88      @Override
89      public String getReasonPhrase() {
90          return this.reasonPhrase;
91      }
92  
93      @Override
94      public String toString() {
95          // no need for non-default formatting in toString()
96          return BasicLineFormatter.INSTANCE.formatStatusLine(null, this).toString();
97      }
98  
99      @Override
100     public Object clone() throws CloneNotSupportedException {
101         return super.clone();
102     }
103 
104 }