001/*
002 * Copyright (c) 2007-2016 Concurrent, Inc. All Rights Reserved.
003 *
004 * Project and contact information: http://www.cascading.org/
005 *
006 * This file is part of the Cascading project.
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *     http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020
021package cascading.util.cache;
022
023import cascading.flow.FlowProcess;
024import cascading.provider.CascadingFactory;
025
026/**
027 * Base class for all CacheFactories for creating {@link CascadingCache} instances. Each sub-assembly using
028 * the {@link CascadingCache} facilities has it's own sub-class of this factory so that different Caches
029 * can be used for different parts of the same flow.
030 * <p/>
031 * A {@link cascading.util.cache.CacheEvictionCallback} can be set and it will be given to each Cache instance created
032 * by the factory. If none is set, the Factory will use {@link cascading.util.cache.CacheEvictionCallback#NULL}, which
033 * is a no-op implementation of the {@link cascading.util.cache.CacheEvictionCallback} interface.
034 */
035public abstract class BaseCacheFactory<Key, Value, Config> implements CascadingFactory<Config, CascadingCache<Key, Value>>
036  {
037  /** default capacity for all caches. */
038  public static final int DEFAULT_CAPACITY = 10000;
039
040  @Override
041  public void initialize( FlowProcess<? extends Config> flowProcess )
042    {
043
044    }
045
046  @Override
047  public abstract CascadingCache<Key, Value> create( FlowProcess<? extends Config> flowProcess );
048  }