Class AbstractStringRestriction

java.lang.Object
com.github.rvesse.airline.restrictions.AbstractCommonRestriction
com.github.rvesse.airline.restrictions.common.AbstractStringRestriction
All Implemented Interfaces:
ArgumentsRestriction, OptionRestriction
Direct Known Subclasses:
AbstractLocaleAndCaseStringRestriction, LengthRestriction, NotBlankRestriction, NotEmptyRestriction

public abstract class AbstractStringRestriction extends AbstractCommonRestriction
Abstract restrictions on string values for options and arguments
  • Constructor Details

    • AbstractStringRestriction

      public AbstractStringRestriction()
  • Method Details

    • preValidate

      public final <T> void preValidate(ParseState<T> state, OptionMetadata option, String value)
      Description copied from interface: OptionRestriction
      Method that is called before Airline attempts to convert a string argument received into a strongly typed Java value
      Specified by:
      preValidate in interface OptionRestriction
      Overrides:
      preValidate in class AbstractCommonRestriction
      Parameters:
      state - Parser state
      option - Option meta-data
      value - String value
    • preValidate

      public final <T> void preValidate(ParseState<T> state, ArgumentsMetadata arguments, String value)
      Description copied from interface: ArgumentsRestriction
      Method that is called before Airline attempts to convert a string argument received into a strongly typed Java value
      Specified by:
      preValidate in interface ArgumentsRestriction
      Overrides:
      preValidate in class AbstractCommonRestriction
      Parameters:
      state - Parser state
      arguments - Arguments meta-data
      value - String value
    • isValid

      protected abstract boolean isValid(String value)
      Method that derived classes must implement to check whether a value is valid
      Parameters:
      value - Value
      Returns:
      True if valid, false if valid
    • violated

      protected abstract <T> ParseRestrictionViolatedException violated(ParseState<T> state, OptionMetadata option, String value)
      Method that derived classes must implement to provide an exception for the case of an invalid option value, this will be called if isValid(String) returns false
      Parameters:
      state - Parser state
      option - Option metadata for the option whose value is being checked
      value - Value which has been deemed invalid
      Returns:
      Exception
    • violated

      protected abstract <T> ParseRestrictionViolatedException violated(ParseState<T> state, ArgumentsMetadata arguments, String value)
      Method that derived classes must implement to provide an exception for the case of an invalid argument value, this will be called if isValid(String) returns false
      Parameters:
      state - Parser state
      arguments - Arguments metadata
      value - Value which has been deemed invalid
      Returns:
      Exception