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.message;
29  
30  import java.io.IOException;
31  import java.util.Locale;
32  
33  import org.apache.hc.core5.http.ClassicHttpResponse;
34  import org.apache.hc.core5.http.HttpEntity;
35  import org.apache.hc.core5.http.ReasonPhraseCatalog;
36  import org.apache.hc.core5.io.Closer;
37  
38  /**
39   * Basic implementation of {@link ClassicHttpResponse}.
40   *
41   * @since 5.0
42   */
43  public class BasicClassicHttpResponse extends BasicHttpResponse implements ClassicHttpResponse {
44  
45      private static final long serialVersionUID = 1L;
46      private HttpEntity entity;
47  
48      /**
49       * Creates a new response.
50       *
51       * @param code              the status code
52       * @param catalog           the reason phrase catalog, or
53       *                          {@code null} to disable automatic
54       *                          reason phrase lookup
55       * @param locale            the locale for looking up reason phrases, or
56       *                          {@code null} for the system locale
57       */
58      public BasicClassicHttpResponse(final int code, final ReasonPhraseCatalog catalog, final Locale locale) {
59          super(code, catalog, locale);
60      }
61  
62      /**
63       * Creates a new response.
64       *
65       * @param code          the status code of the response
66       * @param reasonPhrase  the reason phrase to the status code, or {@code null}
67       */
68      public BasicClassicHttpResponse(final int code, final String reasonPhrase) {
69          super(code, reasonPhrase);
70      }
71  
72      /**
73       * Creates a new response.
74       *
75       * @param code          the status code of the response
76       */
77      public BasicClassicHttpResponse(final int code) {
78          super(code);
79      }
80  
81      @Override
82      public HttpEntity getEntity() {
83          return this.entity;
84      }
85  
86      @Override
87      public void setEntity(final HttpEntity entity) {
88          this.entity = entity;
89      }
90  
91      @Override
92      public void close() throws IOException {
93          Closer.close(entity);
94      }
95  
96  }