NullCacheStorage.java

/*
 * 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.
 */

package freemarker.cache;

/**
 * A cache storage that doesn't store anything. Use this if you
 * don't want caching.
 *
 * @see freemarker.template.Configuration#setCacheStorage(CacheStorage)
 * 
 * @since 2.3.17
 */
public class NullCacheStorage implements ConcurrentCacheStorage, CacheStorageWithGetSize {
    
    /**
     * @since 2.3.22
     */
    public static final NullCacheStorage INSTANCE = new NullCacheStorage();

    public boolean isConcurrent() {
        return true;
    }
    
    public Object get(Object key) {
        return null;
    }

    public void put(Object key, Object value) {
        // do nothing
    }

    public void remove(Object key) {
        // do nothing
    }
    
    public void clear() {
        // do nothing
    }

    /**
     * Always returns 0.
     * 
     * @since 2.3.21
     */
    public int getSize() {
        return 0;
    }
    
}