Class OptionDescriber.IteratorOptions

Enclosing interface:

public static class OptionDescriber.IteratorOptions extends Object
  • Field Details

  • Constructor Details

    • IteratorOptions

      public IteratorOptions(String name, String description, Map<String,String> namedOptions, List<String> unnamedOptionDescriptions)
      IteratorOptions holds the name, description, and option information for an iterator.
      name - is the distinguishing name for the iterator or filter
      description - is a description of the iterator or filter
      namedOptions - is a map from specifically named options to their descriptions (null if unused) e.g., the AgeOffFilter requires a parameter called "ttl", so its namedOptions = Collections.singletonMap("ttl", "time to live (milliseconds)")
      unnamedOptionDescriptions - is a list of descriptions of additional options that don't have fixed names (null if unused). The descriptions are intended to describe a category, and the user will provide parameter names and values in that category; e.g., the FilteringIterator needs a list of Filters intended to be named by their priority numbers, so it's
      unnamedOptionDescriptions = Collections
      .singletonList("<filterPriorityNumber> <ageoff|regex|filterClass>")
  • Method Details

    • getNamedOptions

      public Map<String,String> getNamedOptions()
    • getUnnamedOptionDescriptions

      public List<String> getUnnamedOptionDescriptions()
    • getName

      public String getName()
    • getDescription

      public String getDescription()
    • setNamedOptions

      public void setNamedOptions(Map<String,String> namedOptions)
    • setUnnamedOptionDescriptions

      public void setUnnamedOptionDescriptions(List<String> unnamedOptionDescriptions)
    • setName

      public void setName(String name)
    • setDescription

      public void setDescription(String description)
    • addNamedOption

      public void addNamedOption(String name, String description)
    • addUnnamedOption

      public void addUnnamedOption(String description)