001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portal.kernel.cache.key;
016    
017    import com.liferay.portal.kernel.util.StringBundler;
018    
019    import java.io.Serializable;
020    
021    /**
022     * @author Michael C. Han
023     * @author Shuyang Zhou
024     */
025    public interface CacheKeyGenerator extends Cloneable {
026    
027            public CacheKeyGenerator append(String key);
028    
029            public CacheKeyGenerator append(String[] keys);
030    
031            public CacheKeyGenerator append(StringBundler sb);
032    
033            public CacheKeyGenerator clone();
034    
035            public Serializable finish();
036    
037            public Serializable getCacheKey(String key);
038    
039            public Serializable getCacheKey(String[] keys);
040    
041            public Serializable getCacheKey(StringBundler sb);
042    
043    }