Package ru.lanwen.verbalregex

Class VerbalExpression

  • public class VerbalExpression
extends java.lang.Object

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.regex.Pattern pattern  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getText​(java.lang.String toTest)
      Extract full string that matches regex Same as getText(String, int) for 0 group
      java.lang.String getText​(java.lang.String toTest, int group)
      Extract exact group from string
      java.lang.String getText​(java.lang.String toTest, java.lang.String group)
      Extract exact named-group from string
      java.util.List<java.lang.String> getTextGroups​(java.lang.String toTest, int group)
      Extract exact group from string and add it to list Example: String text = "SampleHelloWorldString"; VerbalExpression regex = regex().capt().oneOf("Hello", "World").endCapt().maybe("String").build(); list = regex.getTextGroups(text, 0) //result: "Hello", "WorldString" list = regex.getTextGroups(text, 1) //result: "Hello", "World"
      static VerbalExpression.Builder regex()
      Creates new instance of VerbalExpression builder
      static VerbalExpression.Builder regex​(VerbalExpression.Builder pBuilder)
      Creates new instance of VerbalExpression builder from cloned builder
      boolean test​(java.lang.String pToTest)
      Test that full string contains regex
      boolean testExact​(java.lang.String pToTest)
      Test that full string matches regular expression
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • pattern

        private final java.util.regex.Pattern pattern

    • Method Detail

      • testExact

        public boolean testExact​(java.lang.String pToTest)
        Test that full string matches regular expression
        Parameters:
        pToTest - - string to check match
        Returns:
        true if matches exact string, false otherwise

      • test

        public boolean test​(java.lang.String pToTest)
        Test that full string contains regex
        Parameters:
        pToTest - - string to check match
        Returns:
        true if string contains regex, false otherwise

      • getText

        public java.lang.String getText​(java.lang.String toTest)
        Extract full string that matches regex Same as getText(String, int) for 0 group
        Parameters:
        toTest - - string to extract from
        Returns:
        group 0, extracted from text

      • getText

        public java.lang.String getText​(java.lang.String toTest,
                                int group)
        Extract exact group from string
        Parameters:
        toTest - - string to extract from
        group - - group to extract
        Returns:
        extracted group
        Since:
        1.1

      • getText

        public java.lang.String getText​(java.lang.String toTest,
                                java.lang.String group)
        Extract exact named-group from string

        Example is see to VerbalExpression.Builder.capture(String)

        Parameters:
        toTest - - string to extract from
        group - - group to extract
        Returns:
        extracted group
        Since:
        1.6

      • getTextGroups

        public java.util.List<java.lang.String> getTextGroups​(java.lang.String toTest,
                                                      int group)
        Extract exact group from string and add it to list Example: String text = "SampleHelloWorldString"; VerbalExpression regex = regex().capt().oneOf("Hello", "World").endCapt().maybe("String").build(); list = regex.getTextGroups(text, 0) //result: "Hello", "WorldString" list = regex.getTextGroups(text, 1) //result: "Hello", "World"
        Parameters:
        toTest - - string to extract from
        group - - group to extract
        Returns:
        list of extracted groups

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • regex

        public static VerbalExpression.Builder regex​(VerbalExpression.Builder pBuilder)
        Creates new instance of VerbalExpression builder from cloned builder
        Parameters:
        pBuilder - - instance to clone
        Returns:
        new VerbalExpression.Builder copied from passed
        Since:
        1.1

      • regex

        public static VerbalExpression.Builder regex()
        Creates new instance of VerbalExpression builder
        Returns:
        new VerbalExpression.Builder
        Since:
        1.1