001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
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            public boolean isCallingGetCacheKeyThreadSafe();
044    
045    }