Package org.apache.commons.lang3.text

Class StrMatcher

    • Field Detail

      • COMMA_MATCHER

        private static final StrMatcher COMMA_MATCHER
        Deprecated.
        Matches the comma character.

      • TAB_MATCHER

        private static final StrMatcher TAB_MATCHER
        Deprecated.
        Matches the tab character.

      • SPACE_MATCHER

        private static final StrMatcher SPACE_MATCHER
        Deprecated.
        Matches the space character.

      • SPLIT_MATCHER

        private static final StrMatcher SPLIT_MATCHER
        Deprecated.
        Matches the same characters as StringTokenizer, namely space, tab, newline, formfeed.

      • TRIM_MATCHER

        private static final StrMatcher TRIM_MATCHER
        Deprecated.
        Matches the String trim() whitespace characters.

      • SINGLE_QUOTE_MATCHER

        private static final StrMatcher SINGLE_QUOTE_MATCHER
        Deprecated.
        Matches the double quote character.

      • DOUBLE_QUOTE_MATCHER

        private static final StrMatcher DOUBLE_QUOTE_MATCHER
        Deprecated.
        Matches the double quote character.

      • QUOTE_MATCHER

        private static final StrMatcher QUOTE_MATCHER
        Deprecated.
        Matches the single or double quote character.

      • NONE_MATCHER

        private static final StrMatcher NONE_MATCHER
        Deprecated.
        Matches no characters.

    • Constructor Detail

      • StrMatcher

        protected StrMatcher()
        Deprecated.
        Constructs a new instance.

    • Method Detail

      • charMatcher

        public static StrMatcher charMatcher​(char ch)
        Deprecated.
        Creates a matcher from a character.
        Parameters:
        ch - the character to match, must not be null
        Returns:
        a new Matcher for the given char

      • charSetMatcher

        public static StrMatcher charSetMatcher​(char... chars)
        Deprecated.
        Creates a matcher from a set of characters.
        Parameters:
        chars - the characters to match, null or empty matches nothing
        Returns:
        a new matcher for the given char[]

      • charSetMatcher

        public static StrMatcher charSetMatcher​(java.lang.String chars)
        Deprecated.
        Creates a matcher from a string representing a set of characters.
        Parameters:
        chars - the characters to match, null or empty matches nothing
        Returns:
        a new Matcher for the given characters

      • commaMatcher

        public static StrMatcher commaMatcher()
        Deprecated.
        Gets the matcher for the comma character.
        Returns:
        the matcher for a comma

      • doubleQuoteMatcher

        public static StrMatcher doubleQuoteMatcher()
        Deprecated.
        Gets the matcher for the double quote character.
        Returns:
        the matcher for a double quote

      • noneMatcher

        public static StrMatcher noneMatcher()
        Deprecated.
        Gets the matcher for no characters.
        Returns:
        the matcher that matches nothing

      • quoteMatcher

        public static StrMatcher quoteMatcher()
        Deprecated.
        Gets the matcher for the single or double quote character.
        Returns:
        the matcher for a single or double quote

      • singleQuoteMatcher

        public static StrMatcher singleQuoteMatcher()
        Deprecated.
        Gets the matcher for the single quote character.
        Returns:
        the matcher for a single quote

      • spaceMatcher

        public static StrMatcher spaceMatcher()
        Deprecated.
        Gets the matcher for the space character.
        Returns:
        the matcher for a space

      • splitMatcher

        public static StrMatcher splitMatcher()
        Deprecated.
        Gets the matcher for the same characters as StringTokenizer, namely space, tab, newline and form-feed.
        Returns:
        the split matcher

      • stringMatcher

        public static StrMatcher stringMatcher​(java.lang.String str)
        Deprecated.
        Creates a matcher for a string.
        Parameters:
        str - the string to match, null or empty matches nothing
        Returns:
        a new Matcher for the given String

      • tabMatcher

        public static StrMatcher tabMatcher()
        Deprecated.
        Gets the matcher for the tab character.
        Returns:
        the matcher for a tab

      • trimMatcher

        public static StrMatcher trimMatcher()
        Deprecated.
        Gets the matcher to String trim() whitespace characters.
        Returns:
        the trim matcher

      • isMatch

        public int isMatch​(char[] buffer,
                   int pos)
        Deprecated.
        Tests whether the number of matching characters, zero for no match.

        This method is called to check for a match. The parameter pos represents the current position to be checked in the string buffer (a character array which must not be changed). The API guarantees that pos is a valid index for buffer.

        The matching code may check one character or many. It may check characters preceding pos as well as those after.

        It must return zero for no match, or a positive number if a match was found. The number indicates the number of characters that matched.

        Parameters:
        buffer - the text content to match against, do not change
        pos - the starting position for the match, valid for buffer
        Returns:
        the number of matching characters, zero for no match
        Since:
        2.4

      • isMatch

        public abstract int isMatch​(char[] buffer,
                            int pos,
                            int bufferStart,
                            int bufferEnd)
        Deprecated.
        Tests whether the number of matching characters, zero for no match.

        This method is called to check for a match. The parameter pos represents the current position to be checked in the string buffer (a character array which must not be changed). The API guarantees that pos is a valid index for buffer.

        The character array may be larger than the active area to be matched. Only values in the buffer between the specified indices may be accessed.

        The matching code may check one character or many. It may check characters preceding pos as well as those after, so long as no checks exceed the bounds specified.

        It must return zero for no match, or a positive number if a match was found. The number indicates the number of characters that matched.

        Parameters:
        buffer - the text content to match against, do not change
        pos - the starting position for the match, valid for buffer
        bufferStart - the first active index in the buffer, valid for buffer
        bufferEnd - the end index (exclusive) of the active buffer, valid for buffer
        Returns:
        the number of matching characters, zero for no match