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.provider;
023
024import cascading.flow.FlowProcess;
025
026/**
027 * Interface CascadingFactory defines a pluggable "factory" class that can be loaded by the {@link FactoryLoader}
028 * utility.
029 * <p>
030 * Factory instances are created process side (in a cluster for example) to augment any of the internal strategies.
031 *
032 * @see FactoryLoader
033 */
034public interface CascadingFactory<Config, Instance>
035  {
036  /**
037   * Method initialize will configure an initialize this factory instance.
038   *
039   * @param flowProcess of type FlowProcess
040   */
041  void initialize( FlowProcess<? extends Config> flowProcess );
042
043  /**
044   * Method create will return a new instance of the type create by this factory.
045   *
046   * @param flowProcess of type FlowProcess
047   * @return of type Instance
048   */
049  Instance create( FlowProcess<? extends Config> flowProcess );
050  }