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.impl.cache;
28  
29  import org.apache.hc.client5.http.cache.Resource;
30  import org.apache.hc.client5.http.cache.ResourceFactory;
31  import org.apache.hc.client5.http.cache.ResourceIOException;
32  import org.apache.hc.core5.annotation.Contract;
33  import org.apache.hc.core5.annotation.ThreadingBehavior;
34  import org.apache.hc.core5.util.Args;
35  
36  /**
37   * Generates {@link Resource} instances stored entirely in heap.
38   *
39   * @since 4.1
40   */
41  @Contract(threading = ThreadingBehavior.STATELESS)
42  public class HeapResourceFactory implements ResourceFactory {
43  
44      /**
45       * Default instance of {@link HeapResourceFactory}.
46       */
47      public static final HeapResourceFactory INSTANCE = new HeapResourceFactory();
48  
49      @Override
50      public Resource generate(
51              final String requestId,
52              final byte[] content, final int off, final int len) {
53          final byte[] copy = new byte[len];
54          System.arraycopy(content, off, copy, 0, len);
55          return new HeapResource(copy);
56      }
57  
58      @Override
59      public Resource generate(final String requestId, final byte[] content) {
60          return new HeapResource(content != null ? content.clone() : null);
61      }
62  
63      /**
64       * @deprecated Do not use.
65       */
66      @Deprecated
67      @Override
68      public Resource copy(
69              final String requestId,
70              final Resource resource) throws ResourceIOException {
71          Args.notNull(resource, "Resource");
72          return resource;
73      }
74  
75  }