/*
 * 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.
 */
package org.apache.cocoon.pipeline.caching;

import java.io.IOException;
import java.io.OutputStream;
import java.io.Serializable;

public interface CacheValue extends Serializable {

    boolean isValid(CacheKey cacheKey);

    void writeTo(OutputStream outputStream) throws IOException;

    Object getValue();

    /**
     * Sets value of this cache
     *
     * @param value
     */
    void setValue(Object value);

    /**
     * Returns size of this {@link CacheValue} in bytes.
     *
     * @return size of cached value in bytes or -1 if something goes wrong.
     */
    double size();
}