Class QuietFlag

java.lang.Object
org.refcodes.cli.AbstractOperand<Boolean>
org.refcodes.cli.AbstractOption<Boolean>
org.refcodes.cli.Flag
org.refcodes.cli.QuietFlag
All Implemented Interfaces:
Cloneable, Comparable<Operand<?>>, MatchCountAccessor, Operand<Boolean>, Option<Boolean>, ParsedArgsAccessor, Synopsisable, Term, ExceptionAccessor<ArgsSyntaxException>, VisibleAccessor, VisibleAccessor.VisibleBuilder<Term>, VisibleAccessor.VisibleMutator, VisibleAccessor.VisibleProperty, AliasAccessor, Clonable, DescriptionAccessor, EnabledAccessor, Resetable, TypeAccessor<Boolean>, ValueAccessor<Boolean>, Diagnosable, Schemable<DiagnosticOptions>
public class QuietFlag extends Flag
A predefined "be quiet" Flag: A predefined Flag gives its SHORT_OPTION, its LONG_OPTION as well as its ALIAS an according semantics regarded by other subsystems.

  • Field Details

  • Constructor Details

    • QuietFlag

      public QuietFlag()
      Constructs the predefined quiet Flag.

    • QuietFlag

      public QuietFlag(boolean hasShortOption)
      Instantiates the class QuietFlag.
      Parameters:
      hasShortOption - True in case to also enable the short option, else only the long option takes effect.
      See Also:

    • QuietFlag

      public QuietFlag(String aDescription)
      Constructs the predefined quiet Flag.
      Parameters:
      aDescription - The description to be used (without any line breaks).

    • QuietFlag

      public QuietFlag(String aDescription, boolean hasShortOption)
      Instantiates the class QuietFlag.
      Parameters:
      hasShortOption - True in case to also enable the short option, else only the long option takes effect.
      See Also:

  • Method Details

    • getDescription

      public String getDescription()
      Specified by:
      getDescription in interface DescriptionAccessor

    • getException

      public ArgsSyntaxException getException()
      Retrieves the ArgsSyntaxException exception in case invoking Term.parseArgs(String[], CliContext) failed. The exception (and the according suppressed ones alongside the causes) does not necessarily have been thrown by the Term.parseArgs(String[], CliContext) method depending on the semantics of the Term handing the exception (the AnyCondition provides any exceptions it caught even though it did not throw them as of its semantics).
      Specified by:
      getException in interface ExceptionAccessor<ArgsSyntaxException>
      Specified by:
      getException in interface Term
      Returns:
      The ArgsSyntaxException exception occurring while parsing the arguments.

    • setVisible

      public void setVisible(boolean isVisible)

      Visibility in this context means displaying or hiding this Term's existence to the user (defaults to true).

      Specified by:
      setVisible in interface Term
      Specified by:
      setVisible in interface VisibleAccessor.VisibleMutator

    • isVisible

      public boolean isVisible()

      Visibility in this context means displaying or hiding this Term's existence to the user (defaults to true).

      Specified by:
      isVisible in interface Term
      Specified by:
      isVisible in interface VisibleAccessor

    • toArgsDiff

      protected static String[] toArgsDiff(String[] aArgs, List<? extends Operand<?>> aArgsSubset)
      Creates the difference between the provided set and the provided Lists therein found argument arrays subset (as of Operand.getParsedArgs()).
      Parameters:
      aArgs - The set to be used for the diff operation.
      aArgsSubset - The subset to be used for the diff operation being the lists containing the Operand instances whose command line arguments are to be diffed.
      Returns:
      The difference between the set and the subset.

    • toArgsDiff

      protected static String[] toArgsDiff(String[] aArgs, Operand<?>[] aArgsSubset)
      Creates the difference between the provided set and the provided Lists therein found argument arrays subset (as of Operand.getParsedArgs()).
      Parameters:
      aArgs - The set to be used for the diff operation.
      aArgsSubset - The subset to be used for the diff operation being the lists containing the Operand instances whose command line arguments are to be diffed.
      Returns:
      The difference between the set and the subset.

    • toArgsDiff

      protected static String[] toArgsDiff(String[] aArgs, String[] aArgsSubset)
      Creates the difference between the provided set and the provided subset.
      Parameters:
      aArgs - The set to be used for the diff operation.
      aArgsSubset - The subset to be used for the diff operation.
      Returns:
      The difference between the set and the subset.

    • toParsedArgs

      protected static String[] toParsedArgs(Operand<?>[]... aOperands)
      Takes all Operand instances found in the provided Lists and adds all therein found argument arrays (as of Operand.getParsedArgs()) to the result.
      Parameters:
      aOperands - The lists containing the Operand instances whose command line arguments are to be added to the result.
      Returns:
      All the command line arguments detected in the provided Operands Lists.