Class IndexMatcher<TOption>

  • Type Parameters:
    TOption - Option type
    All Implemented Interfaces:
    PromptOptionMatcher<TOption>

    public class IndexMatcher<TOption>
    extends java.lang.Object
    implements PromptOptionMatcher<TOption>
    An option matcher that matches options based on the numeric index of the option using 1 based indexes
    • Constructor Summary

      Constructors 
      Constructor Description
      IndexMatcher()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      TOption match​(Prompt<TOption> prompt, java.lang.String response)
      Matches the response to an option provided by the prompt
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • IndexMatcher

        public IndexMatcher()
    • Method Detail

      • match

        public TOption match​(Prompt<TOption> prompt,
                             java.lang.String response)
                      throws PromptException
        Description copied from interface: PromptOptionMatcher
        Matches the response to an option provided by the prompt
        Specified by:
        match in interface PromptOptionMatcher<TOption>
        Parameters:
        prompt - Prompt
        response - Response value that has been read from the prompt
        Returns:
        Matched option
        Throws:
        PromptException - Thrown if the response value does not match any option, or if the matcher is not compatible with the prompt