| package org.apache.jcs.engine; |
| |
| /* |
| * 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. |
| */ |
| |
| import java.io.Serializable; |
| |
| import org.apache.jcs.engine.behavior.ICacheElementSerialized; |
| import org.apache.jcs.engine.behavior.IElementAttributes; |
| |
| /** Either serialized value or the value should be null; */ |
| public class CacheElementSerialized |
| implements ICacheElementSerialized |
| { |
| /** Don't change. */ |
| private static final long serialVersionUID = -7265084818647601874L; |
| |
| /** The name of the cache region. This is a namespace. */ |
| private final String cacheName; |
| |
| /** This is the cache key by which the value can be referenced. */ |
| private final Serializable key; |
| |
| /** The serialized value. */ |
| private final byte[] serializedValue; |
| |
| /** |
| * These attributes hold information about the element and what it is allowed to do. |
| */ |
| private IElementAttributes elementAttributes; |
| |
| /** |
| * Constructs a usable wrapper. |
| * <p> |
| * @param cacheNameArg |
| * @param keyArg |
| * @param serializedValueArg |
| * @param elementAttributesArg |
| */ |
| public CacheElementSerialized( String cacheNameArg, Serializable keyArg, byte[] serializedValueArg, |
| IElementAttributes elementAttributesArg ) |
| { |
| this.cacheName = cacheNameArg; |
| this.key = keyArg; |
| this.serializedValue = serializedValueArg; |
| this.elementAttributes = elementAttributesArg; |
| } |
| |
| /** |
| * Returns the name of the cache. This is the name of the region. |
| * <p> |
| * @return this.cacheName; |
| */ |
| public String getCacheName() |
| { |
| return this.cacheName; |
| } |
| |
| /** @return Serializable */ |
| public Serializable getKey() |
| { |
| return this.key; |
| } |
| |
| /** @return byte[] */ |
| public byte[] getSerializedValue() |
| { |
| return this.serializedValue; |
| } |
| |
| /** @return IElementAttributes */ |
| public IElementAttributes getElementAttributes() |
| { |
| return this.elementAttributes; |
| } |
| |
| /** |
| * @param attr |
| */ |
| public void setElementAttributes( IElementAttributes attr ) |
| { |
| this.elementAttributes = attr; |
| } |
| |
| /** |
| * Backward compatibility. |
| * <p> |
| * @return Serializable |
| */ |
| public Serializable getVal() |
| { |
| return null; |
| } |
| |
| /** |
| * For debugging only. |
| * <p> |
| * @return debugging string. |
| */ |
| public String toString() |
| { |
| StringBuffer buf = new StringBuffer(); |
| buf.append( "\n CacheElementSerialized: " ); |
| buf.append( "\n CacheName = [" + getCacheName() + "]" ); |
| buf.append( "\n Key = [" + getKey() + "]" ); |
| buf.append( "\n SerializedValue = " + getSerializedValue() ); |
| buf.append( "\n ElementAttributes = " + getElementAttributes() ); |
| return buf.toString(); |
| } |
| |
| } |