java/src/main/com/google/appengine/tools/util/ActionsAndOptions.java

   1 // Copyright 2012 Google Inc. All Rights Reserved.
   2
   3 package com.google.appengine.tools.util;
   4
   5 import java.util.HashMap;
   6 import java.util.List;
   7 import java.util.Map;
   8
   9 /**
  10  * A container for the collection of {@link Action Actions} and {@link Option Options} that may be
  11  * passed to the {@code AppCfg} command-line tool.
  12  * <p>
  13  * This class is not thread-safe. An instance should only be accessed by one thread at-a-time.
  14  *
  15  */
  16 public class ActionsAndOptions {
  17
  18   /**
  19    * All {@link Action Actions} in processing order
  20    */
  21   public List<Action> actions;
  22
  23   /**
  24    */
  25   public List<Option> options;
  26
  27   /**
  28    * Action names in help-string order
  29    */
  30   public List<String> actionNames;
  31
  32   /**
  33    * Option names in help-string order
  34    */
  35   public List<String> optionNames;
  36
  37   /**
  38    * General option names in help-string order
  39    */
  40   public List<String> generalOptionNames;
  41
  42   /**
  43    * Name to object caches
  44    */
  45   private Map<String, Option> nameToOptionMap;
  46   private Map<String, Action> nameToActionMap;
  47
  48   /**
  49    * After {@link #options} has been set, this method may be invoked to lookup an option by its
  50    * long name.
  51    */
  52   public Option getOption(String name) {
  53     if (options == null) {
  54       throw new IllegalStateException("options must be set first");
  55     }
  56     if (nameToOptionMap == null) {
  57       nameToOptionMap = new HashMap<String, Option>(options.size() * 2);
  58       for (Option option : options) {
  59         nameToOptionMap.put(option.getLongName(), option);
  60       }
  61     }
  62     return nameToOptionMap.get(name);
  63
  64   }
  65
  66   /**
  67    * After {@link #actions} has been set, this method may be invoked to lookup an option by its
  68    * name string.
  69    */
  70   public Action getAction(String name) {
  71     if (actions == null) {
  72       throw new IllegalStateException("actions must be set first");
  73     }
  74     if (nameToActionMap == null) {
  75       nameToActionMap = new HashMap<String, Action>(actions.size() * 2);
  76       for (Action action : actions) {
  77         nameToActionMap.put(action.getNameString(), action);
  78       }
  79     }
  80     return nameToActionMap.get(name);
  81
  82   }
  83 }