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.hc.core5.http.support;
29  
30  import org.apache.hc.core5.http.Header;
31  import org.apache.hc.core5.http.HttpResponse;
32  import org.apache.hc.core5.http.ProtocolVersion;
33  import org.apache.hc.core5.http.message.BasicHttpResponse;
34  import org.apache.hc.core5.util.Args;
35  
36  import java.util.Arrays;
37  
38  /**
39   * Builder for {@link BasicHttpResponse} instances.
40   *
41   * @since 5.1
42   */
43  public class BasicResponseBuilder extends AbstractResponseBuilder<BasicHttpResponse> {
44  
45      protected BasicResponseBuilder(final int status) {
46          super(status);
47      }
48  
49      public static BasicResponseBuilder create(final int status) {
50          Args.checkRange(status, 100, 599, "HTTP status code");
51          return new BasicResponseBuilder(status);
52      }
53  
54      public static BasicResponseBuilder copy(final HttpResponse response) {
55          Args.notNull(response, "HTTP response");
56          final BasicResponseBuildercResponseBuilder.html#BasicResponseBuilder">BasicResponseBuilder builder = new BasicResponseBuilder(response.getCode());
57          builder.digest(response);
58          return builder;
59      }
60  
61      @Override
62      public BasicResponseBuilder setVersion(final ProtocolVersion version) {
63          super.setVersion(version);
64          return this;
65      }
66  
67      @Override
68      public BasicResponseBuilder setHeaders(final Header... headers) {
69          super.setHeaders(headers);
70          return this;
71      }
72  
73      @Override
74      public BasicResponseBuilder addHeader(final Header header) {
75          super.addHeader(header);
76          return this;
77      }
78  
79      @Override
80      public BasicResponseBuilder addHeader(final String name, final String value) {
81          super.addHeader(name, value);
82          return this;
83      }
84  
85      @Override
86      public BasicResponseBuilder removeHeader(final Header header) {
87          super.removeHeader(header);
88          return this;
89      }
90  
91      @Override
92      public BasicResponseBuilder removeHeaders(final String name) {
93          super.removeHeaders(name);
94          return this;
95      }
96  
97      @Override
98      public BasicResponseBuilder setHeader(final Header header) {
99          super.setHeader(header);
100         return this;
101     }
102 
103     @Override
104     public BasicResponseBuilder setHeader(final String name, final String value) {
105         super.setHeader(name, value);
106         return this;
107     }
108 
109     @Override
110     public BasicHttpResponse build() {
111         final BasicHttpResponseBasicHttpResponse.html#BasicHttpResponse">BasicHttpResponse result = new BasicHttpResponse(getStatus());
112         result.setVersion(getVersion());
113         result.setHeaders(getHeaders());
114         return result;
115     }
116 
117     @Override
118     public String toString() {
119         final StringBuilder builder = new StringBuilder();
120         builder.append("BasicResponseBuilder [status=");
121         builder.append(getStatus());
122         builder.append(", headerGroup=");
123         builder.append(Arrays.toString(getHeaders()));
124         builder.append("]");
125         return builder.toString();
126     }
127 
128 }