001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027
028package org.apache.http.message;
029
030import java.io.Serializable;
031
032import org.apache.http.ProtocolVersion;
033import org.apache.http.StatusLine;
034import org.apache.http.annotation.ThreadingBehavior;
035import org.apache.http.annotation.Contract;
036import org.apache.http.util.Args;
037
038/**
039 * Basic implementation of {@link StatusLine}
040 *
041 * @since 4.0
042 */
043@Contract(threading = ThreadingBehavior.IMMUTABLE)
044public class BasicStatusLine implements StatusLine, Cloneable, Serializable {
045
046    private static final long serialVersionUID = -2443303766890459269L;
047
048    // ----------------------------------------------------- Instance Variables
049
050    /** The protocol version. */
051    private final ProtocolVersion protoVersion;
052
053    /** The status code. */
054    private final int statusCode;
055
056    /** The reason phrase. */
057    private final String reasonPhrase;
058
059    // ----------------------------------------------------------- Constructors
060    /**
061     * Creates a new status line with the given version, status, and reason.
062     *
063     * @param version           the protocol version of the response
064     * @param statusCode        the status code of the response
065     * @param reasonPhrase      the reason phrase to the status code, or
066     *                          {@code null}
067     */
068    public BasicStatusLine(final ProtocolVersion version, final int statusCode,
069                           final String reasonPhrase) {
070        super();
071        this.protoVersion = Args.notNull(version, "Version");
072        this.statusCode = Args.notNegative(statusCode, "Status code");
073        this.reasonPhrase = reasonPhrase;
074    }
075
076    // --------------------------------------------------------- Public Methods
077
078    @Override
079    public int getStatusCode() {
080        return this.statusCode;
081    }
082
083    @Override
084    public ProtocolVersion getProtocolVersion() {
085        return this.protoVersion;
086    }
087
088    @Override
089    public String getReasonPhrase() {
090        return this.reasonPhrase;
091    }
092
093    @Override
094    public String toString() {
095        // no need for non-default formatting in toString()
096        return BasicLineFormatter.INSTANCE.formatStatusLine(null, this).toString();
097    }
098
099    @Override
100    public Object clone() throws CloneNotSupportedException {
101        return super.clone();
102    }
103
104}