org.apache.hc.client5.http.cache.HttpCacheEntrySerializer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of httpclient5-cache Show documentation

Apache HttpComponents HttpClient Cache

There is a newer version: 5.4.1

/*
 * ====================================================================
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * .
 *
 */
package org.apache.hc.client5.http.cache;

import org.apache.hc.core5.annotation.Contract;
import org.apache.hc.core5.annotation.ThreadingBehavior;

/**
 * Serializer / deserializer for {@link HttpCacheStorageEntry} entries.
 *
 * @since 5.0
 */
@Contract(threading = ThreadingBehavior.STATELESS)
public interface HttpCacheEntrySerializer {

    /**
     * Serializes the given entry.
     *
     * @param entry cache entry
     * @return serialized representation of the cache entry
     * @throws ResourceIOException
     */
    T serialize(HttpCacheStorageEntry entry) throws ResourceIOException;

    /**
     * Deserializes a cache entry from its serialized representation.
     * @param serializedObject serialized representation of the cache entry
     * @return cache entry
     * @throws ResourceIOException
     */
    HttpCacheStorageEntry deserialize(T serializedObject) throws ResourceIOException;

}