View Javadoc
1   /*
2    * Copyright 2016 Function1. All Rights Reserved.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *    http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package tools.gsf.config;
17  
18  /**
19   * This class defines a way by which factories can be returned for the scope specified.
20   *
21   * @author Tony Field
22   * @since 2016-08-05
23   */
24  public interface FactoryProducer {
25  
26      /**
27       * Get the factory configured for the scope specified. If no factory is present for the
28       * specified scope, an IllegalArgumentException is thrown.
29       *
30       * @param scope the scope
31       * @return the factory
32       * @throws IllegalArgumentException if no factory exists for the specified scope. null is
33       *                                  not a valid scope.
34       */
35      Factory getFactory(Object scope);
36  }