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  package org.apache.hc.client5.http.cache;
28  
29  import java.io.Serializable;
30  
31  import org.apache.hc.core5.annotation.Contract;
32  import org.apache.hc.core5.annotation.ThreadingBehavior;
33  import org.apache.hc.core5.util.Args;
34  
35  /**
36   * This class contains a {@link HttpCacheEntry} along with its key.
37   *
38   * @since 5.0
39   */
40  @Contract(threading = ThreadingBehavior.IMMUTABLE)
41  public final class HttpCacheStorageEntry implements Serializable {
42  
43      private static final long serialVersionUID = 1L;
44      private final String key;
45      private final HttpCacheEntry content;
46  
47      public HttpCacheStorageEntry(final String key, final HttpCacheEntry content) {
48          this.key = key;
49          this.content = Args.notNull(content, "Cache entry");
50      }
51  
52      public String getKey() {
53          return key;
54      }
55  
56      public HttpCacheEntry getContent() {
57          return content;
58      }
59  
60      @Override
61      public String toString() {
62          return "[key=" + key + "; content=" + content + "]";
63      }
64  
65  }