Package org.pkl.core

Record Class CommandSpec.Flag

java.lang.Object
java.lang.Record
org.pkl.core.CommandSpec.Flag
All Implemented Interfaces:
CommandSpec.Option
Enclosing class:
CommandSpec
public static record CommandSpec.Flag(String name, @Nullable String helpText, boolean showAsRequired, BiFunction<String,URI,Object> transformEach, BiFunction<List<Object>,URI,Object> transformAll, @Nullable CommandSpec.CompletionCandidates completionCandidates, @Nullable String shortName, String metavar, boolean hidden, @Nullable String defaultValue) extends Record implements CommandSpec.Option

  • Constructor Details

    • Flag

      public Flag(String name, @Nullable @Nullable String helpText, boolean showAsRequired, BiFunction<String,URI,Object> transformEach, BiFunction<List<Object>,URI,Object> transformAll, @Nullable @Nullable CommandSpec.CompletionCandidates completionCandidates, @Nullable @Nullable String shortName, String metavar, boolean hidden, @Nullable @Nullable String defaultValue)
      Creates an instance of a Flag record class.
      Parameters:
      name - the value for the name record component
      helpText - the value for the helpText record component
      showAsRequired - the value for the showAsRequired record component
      transformEach - the value for the transformEach record component
      transformAll - the value for the transformAll record component
      completionCandidates - the value for the completionCandidates record component
      shortName - the value for the shortName record component
      metavar - the value for the metavar record component
      hidden - the value for the hidden record component
      defaultValue - the value for the defaultValue record component

  • Method Details

    • getNames

      public String[] getNames()
      Specified by:
      getNames in interface CommandSpec.Option

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public String name()
      Returns the value of the name record component.
      Specified by:
      name in interface CommandSpec.Option
      Returns:
      the value of the name record component

    • helpText

      @Nullable public @Nullable String helpText()
      Returns the value of the helpText record component.
      Returns:
      the value of the helpText record component

    • showAsRequired

      public boolean showAsRequired()
      Returns the value of the showAsRequired record component.
      Returns:
      the value of the showAsRequired record component

    • transformEach

      public BiFunction<String,URI,Object> transformEach()
      Returns the value of the transformEach record component.
      Returns:
      the value of the transformEach record component

    • transformAll

      public BiFunction<List<Object>,URI,Object> transformAll()
      Returns the value of the transformAll record component.
      Returns:
      the value of the transformAll record component

    • completionCandidates

      @Nullable public @Nullable CommandSpec.CompletionCandidates completionCandidates()
      Returns the value of the completionCandidates record component.
      Returns:
      the value of the completionCandidates record component

    • shortName

      @Nullable public @Nullable String shortName()
      Returns the value of the shortName record component.
      Returns:
      the value of the shortName record component

    • metavar

      public String metavar()
      Returns the value of the metavar record component.
      Returns:
      the value of the metavar record component

    • hidden

      public boolean hidden()
      Returns the value of the hidden record component.
      Returns:
      the value of the hidden record component

    • defaultValue

      @Nullable public @Nullable String defaultValue()
      Returns the value of the defaultValue record component.
      Returns:
      the value of the defaultValue record component