src/main/gov/nasa/jpf/util/json/CGCreator.java

   1 /*
   2  * Copyright (C) 2014, United States Government, as represented by the
   3  * Administrator of the National Aeronautics and Space Administration.
   4  * All rights reserved.
   5  *
   6  * The Java Pathfinder core (jpf-core) platform is licensed under the
   7  * Apache License, Version 2.0 (the "License"); you may not use this file except
   8  * in compliance with the License. You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0.
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18
  19 package gov.nasa.jpf.util.json;
  20
  21 import gov.nasa.jpf.vm.ChoiceGenerator;
  22
  23 /**
  24  * Creates Choice generator from Value array.
  25  * We need this interface because there are too many Choice Generators in JPF if we
  26  * will try to create CG trying to match CG constructors parameters and Values array
  27  * we will have following problems:
  28  * <li> Ambiguity with some constructors
  29  * <li> User would unable to create some kind of CG (some requires Config for example)
  30  * <li> User would need to specify unique ids in JSON
  31  * @see Value
  32  * @author Ivan Mushketik
  33  */
  34 public interface CGCreator {
  35
  36   /**
  37    * Create choice generator
  38    * @param id - unique id for this CG
  39    * @param params - params read from JSON file
  40    * @return new CG.
  41    */
  42   public ChoiceGenerator<?> createCG(String id, Value[] params);
  43 }