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