Package com.globalmentor.text

Class RegularExpressions

  • public class RegularExpressions
extends java.lang.Object
    Constants and utility methods for regular expression-related tasks.
    Author:
    Garret Wilson

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static char CHARACTER_CLASS_BEGIN
      The beginning character of a character class.
      static char CHARACTER_CLASS_END
      The ending character of a character class.
      static char ESCAPE
      The character used for escaping regular expressions.
      static char ONE_OR_MORE_CHAR
      The symbol for specifying one or more repetitions.
      static Characters RESTRICTED
      The restricted characters which must be escaped in regular expressions.
      static char WILDCARD_CHAR
      The regular expression character that matches any character.
      static char ZERO_OR_MORE_CHAR
      The symbol for specifying zero or more repetitions.
      static char ZERO_OR_ONE_CHAR
      The symbol for specifying zero or one repetitions.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String createCharacterClass​(char... characters)
      Creates a regular expression character class (e.g.
      static java.lang.String createCharacterClass​(Characters characters)
      Creates a regular expression character class (e.g.
      static java.lang.String escapePatternString​(java.lang.String patternString)
      Escapes restricted characters meant to appear in a pattern.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • WILDCARD_CHAR

        public static final char WILDCARD_CHAR
        The regular expression character that matches any character.
        See Also:
        Constant Field Values

      • ZERO_OR_ONE_CHAR

        public static final char ZERO_OR_ONE_CHAR
        The symbol for specifying zero or one repetitions.
        See Also:
        Constant Field Values

      • ZERO_OR_MORE_CHAR

        public static final char ZERO_OR_MORE_CHAR
        The symbol for specifying zero or more repetitions.
        See Also:
        Constant Field Values

      • ONE_OR_MORE_CHAR

        public static final char ONE_OR_MORE_CHAR
        The symbol for specifying one or more repetitions.
        See Also:
        Constant Field Values

      • CHARACTER_CLASS_BEGIN

        public static final char CHARACTER_CLASS_BEGIN
        The beginning character of a character class.
        See Also:
        Constant Field Values

      • CHARACTER_CLASS_END

        public static final char CHARACTER_CLASS_END
        The ending character of a character class.
        See Also:
        Constant Field Values

      • RESTRICTED

        public static final Characters RESTRICTED
        The restricted characters which must be escaped in regular expressions.

      • ESCAPE

        public static final char ESCAPE
        The character used for escaping regular expressions.
        See Also:
        Constant Field Values

    • Constructor Detail

      • RegularExpressions

        public RegularExpressions()

    • Method Detail

      • createCharacterClass

        public static java.lang.String createCharacterClass​(char... characters)
        Creates a regular expression character class (e.g. "[abc]") from the given characters (e.g. 'a', 'b', and 'c').
        Parameters:
        characters - The characters to be included in the character class.
        Returns:
        The new character class including the given characters.
        Throws:
        java.lang.NullPointerException - if the given characters is null.
        See Also:
        escapePatternString(String)

      • createCharacterClass

        public static java.lang.String createCharacterClass​(Characters characters)
        Creates a regular expression character class (e.g. "[abc]") from the given characters (e.g. 'a', 'b', and 'c').
        Parameters:
        characters - The characters to be included in the character class.
        Returns:
        The new character class including the given characters.
        Throws:
        java.lang.NullPointerException - if the given characters is null.
        See Also:
        escapePatternString(String)

      • escapePatternString

        public static java.lang.String escapePatternString​(java.lang.String patternString)
        Escapes restricted characters meant to appear in a pattern.
        Parameters:
        patternString - The string to appear in a pattern.
        Returns:
        The pattern string with restricted characters escaped.
        See Also:
        RESTRICTED, ESCAPE