src/main/gov/nasa/jpf/util/event/EventForest.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.event;
  20
  21 import java.util.HashMap;
  22
  23 /**
  24  * a forest of named event trees
  25  *
  26  * This class mostly exists for the purpose of tree construction, which happens from respective ctors like
  27  *
  28  *  EventForest myForest = new EventForest(){
  29  *    @Override
  30  *    protected Event createRoot(){
  31  *        addRoot("someState",
  32  *                sequence(
  33  *                    event(..),
  34  *                 ...
  35  *        );
  36  *
  37  *        addRoot("someOtherState",
  38  *                ...
  39  *
  40  *        return sequence( ... ); // default tree
  41  *   }
  42  *
  43  */
  44 public abstract class EventForest extends EventTree {
  45
  46   protected HashMap<String,Event> rootMap;
  47
  48   //--- construction
  49
  50   /**
  51    *  usually called from createRootEvent()
  52    */
  53   public void addRoot (String name, Event nextRoot){
  54     if (rootMap == null){
  55       rootMap = new HashMap<>();
  56     }
  57     rootMap.put(name, nextRoot);
  58   }
  59
  60
  61   //--- accessors
  62
  63   public Event getRoot (String name) {
  64     if (rootMap != null) {
  65       return rootMap.get(name);
  66     } else {
  67       return null;
  68     }
  69   }
  70 }