001    /**
002     * Copyright (c) 2000-2012 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.cache.key;
016    
017    import com.liferay.portal.kernel.cache.key.CacheKeyGenerator;
018    import com.liferay.portal.kernel.util.StringBundler;
019    
020    import java.io.Serializable;
021    
022    /**
023     * @author Shuyang Zhou
024     */
025    public abstract class BaseCacheKeyGenerator implements CacheKeyGenerator {
026    
027            public CacheKeyGenerator append(String key) {
028                    keyBundler.append(key);
029    
030                    return this;
031            }
032    
033            public CacheKeyGenerator append(String[] keys) {
034                    keyBundler.append(keys);
035    
036                    return this;
037            }
038    
039            public CacheKeyGenerator append(StringBundler sb) {
040                    keyBundler.append(sb);
041    
042                    return this;
043            }
044    
045            @Override
046            public abstract CacheKeyGenerator clone();
047    
048            public Serializable finish() {
049                    Serializable cacheKey = getCacheKey(keyBundler);
050    
051                    keyBundler.setIndex(0);
052    
053                    return cacheKey;
054            }
055    
056            public boolean isCallingGetCacheKeyThreadSafe() {
057                    return _CALLING_GET_CACHE_KEY_THREAD_SAFE;
058            }
059    
060            protected StringBundler keyBundler = new StringBundler();
061    
062            private static final boolean _CALLING_GET_CACHE_KEY_THREAD_SAFE = true;
063    
064    }