Class RegexMatcher

java.lang.Object
joptsimple.util.RegexMatcher
All Implemented Interfaces:
ValueConverter<String>
public class RegexMatcher extends Object implements ValueConverter<String>
Ensures that values entirely match a regular expression.

  • Field Details

    • pattern

      private final Pattern pattern

  • Constructor Details

    • RegexMatcher

      public RegexMatcher(String pattern, int flags)
      Creates a matcher that uses the given regular expression, modified by the given flags.
      Parameters:
      pattern - the regular expression pattern
      flags - modifying regex flags
      Throws:
      IllegalArgumentException - if bit values other than those corresponding to the defined match flags are set in flags
      PatternSyntaxException - if the expression's syntax is invalid

  • Method Details

    • regex

      public static ValueConverter<String> regex(String pattern)
      Gives a matcher that uses the given regular expression.
      Parameters:
      pattern - the regular expression pattern
      Returns:
      the new converter
      Throws:
      PatternSyntaxException - if the expression's syntax is invalid

    • convert

      public String convert(String value)
      Description copied from interface: ValueConverter
      Converts the given string value into a Java type.
      Specified by:
      convert in interface ValueConverter<String>
      Parameters:
      value - the string to convert
      Returns:
      the converted value

    • valueType

      public Class<String> valueType()
      Description copied from interface: ValueConverter
      Gives the class of the type of values this converter converts to.
      Specified by:
      valueType in interface ValueConverter<String>
      Returns:
      the target class for conversion

    • valuePattern

      public String valuePattern()
      Description copied from interface: ValueConverter
      Gives a string that describes the pattern of the values this converter expects, if any. For example, a date converter can respond with a date format string.
      Specified by:
      valuePattern in interface ValueConverter<String>
      Returns:
      a value pattern, or null if there's nothing interesting here

    • raiseValueConversionFailure

      private void raiseValueConversionFailure(String value)