org.apache.cocoon.pipeline.caching.ObjectCacheValue Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cocoon-pipeline Show documentation
The core of Cocoon 3. A Servlet API independent implementation of pipelines.
The newest version!
/*
 * 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.ByteArrayOutputStream;
import java.io.IOException;
import java.io.ObjectOutputStream;
import java.io.OutputStream;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * An implementation of the {@link CacheValue} interface that can hold an arbitrary value.
 */
public class ObjectCacheValue extends AbstractCacheValue {

    private static final long serialVersionUID = 1L;

    private final Object value;

    private final Log logger = LogFactory.getLog(this.getClass());

    public ObjectCacheValue(Object value, CacheKey cacheKey) {
        super(cacheKey);

        this.value = value;
    }

    /**
     * {@inheritDoc}
     * 
     * @see org.apache.cocoon.pipeline.caching.CacheValue#getValue()
     */
    public Object getValue() {
        return this.value;
    }

    /**
     * {@inheritDoc}
     *
     * @see org.apache.cocoon.pipeline.caching.CacheValue#setValue()
     */
    public void setValue(Object value) {
        throw new UnsupportedOperationException("Cannot set the content of ObjectCacheValue to OutputStream.");
    }

    /**
     * {@inheritDoc}
     *
     * @see org.apache.cocoon.pipeline.caching.CacheValue#size()
     */
    public double size() {
        ByteArrayOutputStream byteOut = new ByteArrayOutputStream();
        try {
            ObjectOutputStream objectOut = new ObjectOutputStream(byteOut);
            objectOut.writeObject(this.value);
            objectOut.flush();
            objectOut.close();
        } catch (IOException e) {
            this.logger.error("Some thing goes wrong during calculating size of: " + getCacheKey(), e);
            return -1;
        }
        return byteOut.toByteArray().length;
    }

    /**
     * {@inheritDoc}
     *
     * @see org.apache.cocoon.pipeline.caching.CacheValue#writeTo(java.io.OutputStream)
     */
    public void writeTo(OutputStream outputStream) throws IOException {
        throw new UnsupportedOperationException("Cannot write the content of ObjectCacheValue to OutputStream.");
    }
}