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.Immutable;
35  import org.apache.http.util.Args;
36  
37  /**
38   * Basic implementation of {@link StatusLine}
39   *
40   * @since 4.0
41   */
42  @Immutable
43  public class BasicStatusLine implements StatusLine, Cloneable, Serializable {
44  
45      private static final long serialVersionUID = -2443303766890459269L;
46  
47      // ----------------------------------------------------- Instance Variables
48  
49      /** The protocol version. */
50      private final ProtocolVersion protoVersion;
51  
52      /** The status code. */
53      private final int statusCode;
54  
55      /** The reason phrase. */
56      private final String reasonPhrase;
57  
58      // ----------------------------------------------------------- Constructors
59      /**
60       * Creates a new status line with the given version, status, and reason.
61       *
62       * @param version           the protocol version of the response
63       * @param statusCode        the status code of the response
64       * @param reasonPhrase      the reason phrase to the status code, or
65       *                          <code>null</code>
66       */
67      public BasicStatusLine(final ProtocolVersion version, final int statusCode,
68                             final String reasonPhrase) {
69          super();
70          this.protoVersion = Args.notNull(version, "Version");
71          this.statusCode = Args.notNegative(statusCode, "Status code");
72          this.reasonPhrase = reasonPhrase;
73      }
74  
75      // --------------------------------------------------------- Public Methods
76  
77      @Override
78      public int getStatusCode() {
79          return this.statusCode;
80      }
81  
82      @Override
83      public ProtocolVersion getProtocolVersion() {
84          return this.protoVersion;
85      }
86  
87      @Override
88      public String getReasonPhrase() {
89          return this.reasonPhrase;
90      }
91  
92      @Override
93      public String toString() {
94          // no need for non-default formatting in toString()
95          return BasicLineFormatter.INSTANCE.formatStatusLine(null, this).toString();
96      }
97  
98      @Override
99      public Object clone() throws CloneNotSupportedException {
100         return super.clone();
101     }
102 
103 }