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 org.apache.hc.core5.annotation.Contract;
30 import org.apache.hc.core5.annotation.ThreadingBehavior;
31
32 /**
33 * Serializer / deserializer for {@link HttpCacheStorageEntry} entries.
34 *
35 * @since 5.0
36 */
37 @Contract(threading = ThreadingBehavior.STATELESS)
38 public interface HttpCacheEntrySerializer<T> {
39
40 /**
41 * Serializes the given entry.
42 *
43 * @param entry cache entry
44 * @return serialized representation of the cache entry
45 * @throws ResourceIOException
46 */
47 T serialize(HttpCacheStorageEntry entry) throws ResourceIOException;
48
49 /**
50 * Deserializes a cache entry from its serialized representation.
51 * @param serializedObject serialized representation of the cache entry
52 * @return cache entry
53 * @throws ResourceIOException
54 */
55 HttpCacheStorageEntry deserialize(T serializedObject) throws ResourceIOException;
56
57 }