Package eu.svjatoslav.commons.cli_helper.parameter_parser.parameter

Class DirectoryOptions

java.lang.Object
eu.svjatoslav.commons.cli_helper.parameter_parser.Option<List<File>,DirectoryOptions>
eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.DirectoryOptions
public class DirectoryOptions extends Option<List<File>,DirectoryOptions>
Represents a command-line option that accepts one or more directory paths.

  • Constructor Details

    • DirectoryOptions

      public DirectoryOptions(String description)
      Creates a DirectoryOptions object with a specified description, requiring one or more directories.
      Parameters:
      description - a brief description of what these directories represent.

  • Method Details

    • describeFormat

      public String describeFormat()
      Description copied from class: Option
      Describes the kind or format of the expected parameter(s), e.g. "File", "Integer", etc.
      Specified by:
      describeFormat in class Option<List<File>,DirectoryOptions>
      Returns:
      a short string describing the parameter format

    • getValue

      public List<File> getValue()
      Returns the directories as a list of File objects.
      Specified by:
      getValue in class Option<List<File>,DirectoryOptions>
      Returns:
      the parsed value as the generic type T.

    • mustExist

      public DirectoryOptions mustExist()
      Requires that each directory must exist.
      Returns:
      this DirectoryOptions instance

    • mustNotExist

      public DirectoryOptions mustNotExist()
      Requires that each directory must not exist.
      Returns:
      this DirectoryOptions instance

    • isValid

      public boolean isValid(String value)
      Validates each directory path against the specified ExistenceType.
      Specified by:
      isValid in class Option<List<File>,DirectoryOptions>
      Parameters:
      value - the parameter string to test
      Returns:
      true if valid; false otherwise