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.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            @Override
028            public CacheKeyGenerator append(String key) {
029                    keyBundler.append(key);
030    
031                    return this;
032            }
033    
034            @Override
035            public CacheKeyGenerator append(String[] keys) {
036                    keyBundler.append(keys);
037    
038                    return this;
039            }
040    
041            @Override
042            public CacheKeyGenerator append(StringBundler sb) {
043                    keyBundler.append(sb);
044    
045                    return this;
046            }
047    
048            @Override
049            public abstract CacheKeyGenerator clone();
050    
051            @Override
052            public Serializable finish() {
053                    Serializable cacheKey = getCacheKey(keyBundler);
054    
055                    keyBundler.setIndex(0);
056    
057                    return cacheKey;
058            }
059    
060            @Override
061            public boolean isCallingGetCacheKeyThreadSafe() {
062                    return _CALLING_GET_CACHE_KEY_THREAD_SAFE;
063            }
064    
065            protected StringBundler keyBundler = new StringBundler();
066    
067            private static final boolean _CALLING_GET_CACHE_KEY_THREAD_SAFE = true;
068    
069    }