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