StringGroovyMethods (groovy 2.3.0-rc-1 API)

org.codehaus.groovy.runtime.StringGroovyMethods

This class defines new groovy methods which appear on String-related JDK classes (String, CharSequence, Matcher) inside the Groovy environment. Static methods are used with the first parameter being the destination class, e.g.. public static String reverse(String self) provides a reverse() method for String.
NOTE: While this class contains many 'public' static methods, it is primarily regarded as an internal class (its internal package name suggests this also). We value backwards compatibility of these methods when used within Groovy but value less backwards compatibility at the Java method call level. I.e. future versions of Groovy may remove or move a method call in this file but would normally aim to keep the method available from within Groovy.
Authors:
James Strachan
Jeremy Rayner
Sam Pullara
Rod Cope
Guillaume Laforge
John Wilson
Hein Meling
Dierk Koenig
Pilho Kim
Marc Guillemot
Russel Winder
bing ran
Jochen Theodorou
Paul King
Michael Baehr
Joachim Baumann
Alex Tkachman
Ted Naleid
Brad Long
Jim Jagielski
Rodolfo Velasco
jeremi Joslin
Hamlet D'Arcy
Cedric Champeau
Tim Yates
Dinko Srkoc
Pascal Lombard
Christophe Charles

Methods Summary

Methods
Type	Name and description
`static boolean`	`asBoolean(CharSequence string)` Coerce a string (an instance of CharSequence) to a boolean value.
`static boolean`	`asBoolean(Matcher matcher)` Coerce a Matcher instance to a boolean value.
`static Object`	`asType(CharSequence self, Class c)`
`static Object`	`asType(GString self, Class c)` Converts the GString to a File, or delegates to the default DefaultGroovyMethods.asType
`static Object`	`asType(String self, Class c)` Provides a method to perform custom 'dynamic' type conversion to the given class using the `as` operator.
`static Pattern`	`bitwiseNegate(CharSequence self)` Turns a CharSequence into a regular expression Pattern
`static Pattern`	`bitwiseNegate(String self)` Turns a String into a regular expression Pattern
`static CharSequence`	`capitalize(CharSequence self)` Convenience method to capitalize the first letter of a CharSequence.
`static String`	`capitalize(String self)` Convenience method to capitalize the first letter of a string (typically the first letter of a word).
`static CharSequence`	`center(CharSequence self, Number numberOfChars)` Pad a CharSequence to a minimum length specified by `numberOfChars` by adding the space character around it as many times as needed so that it remains centered.
`static CharSequence`	`center(CharSequence self, Number numberOfChars, CharSequence padding)` Pad a CharSequence to a minimum length specified by `numberOfChars`, appending the supplied padding CharSequence around the original as many times as needed keeping it centered.
`static String`	`center(String self, Number numberOfChars)` Pad a String to a minimum length specified by `numberOfChars` by adding the space character around it as many times as needed so that it remains centered.
`static String`	`center(String self, Number numberOfChars, String padding)` Pad a String to a minimum length specified by `numberOfChars`, appending the supplied padding String around the original as many times as needed keeping it centered.
`static String`	`collectReplacements(String orig, Closure transform)` Iterate through this String a character at a time collecting either the original character or a transformed replacement String.
`static boolean`	`contains(CharSequence self, CharSequence text)` Provide an implementation of contains() like Collection.contains to make CharSequences more polymorphic.
`static boolean`	`contains(String self, String text)` Provide an implementation of contains() like Collection.contains to make Strings more polymorphic.
`static int`	`count(CharSequence self, CharSequence text)` Count the number of occurrences of a sub CharSequence.
`static int`	`count(String self, String text)` Count the number of occurrences of a substring.
`static CharSequence`	`denormalize(CharSequence self)` Return a CharSequence with lines (separated by LF, CR/LF, or CR) terminated by the platform specific line separator.
`static String`	`denormalize(String self)` Return a String with lines (separated by LF, CR/LF, or CR) terminated by the platform specific line separator.
`static CharSequence`	`drop(CharSequence self, int num)` Drops the given number of chars from the head of this CharSequence if they are available.
`static CharSequence`	`dropWhile(CharSequence self, Closure condition)` Create a suffix of the given CharSequence by dropping as many characters as possible from the front of the original CharSequence such that calling the given closure condition evaluates to true when passed each of the dropped characters.
`static Object`	`eachLine(CharSequence self, Closure closure)` Iterates through this CharSequence line by line.
`static Object`	`eachLine(CharSequence self, int firstLine, Closure closure)`
`static Object`	`eachLine(String self, Closure closure)`
`static Object`	`eachLine(String self, int firstLine, Closure closure)`
`static String`	`eachMatch(CharSequence self, CharSequence regex, Closure closure)` Process each regex group matched substring of the given CharSequence.
`static String`	`eachMatch(CharSequence self, Pattern pattern, Closure closure)`
`static String`	`eachMatch(String self, Pattern pattern, Closure closure)`
`static String`	`eachMatch(String self, String regex, Closure closure)` Expands all tabs into spaces with tabStops of size 8.
`static CharSequence`	`expand(CharSequence self)`
`static CharSequence`	`expand(CharSequence self, int tabStop)` Expands all tabs into spaces with tabStops of size 8.
`static String`	`expand(String self)`
`static String`	`expand(String self, int tabStop)`
`static CharSequence`	`expandLine(CharSequence self, int tabStop)` Expands all tabs into spaces.
`static String`	`expandLine(String self, int tabStop)`
`static CharSequence`	`find(CharSequence self, CharSequence regex)`
`static CharSequence`	`find(CharSequence self, CharSequence regex, Closure closure)` Finds the first occurrence of a compiled regular expression Pattern within a CharSequence.
`static CharSequence`	`find(CharSequence self, Pattern pattern)`
`static CharSequence`	`find(CharSequence self, Pattern pattern, Closure closure)`
`static String`	`find(String self, Pattern pattern)`
`static String`	`find(String self, Pattern pattern, Closure closure)`
`static String`	`find(String self, String regex)` Finds the first occurrence of a regular expression String within a String.
`static String`	`find(String self, String regex, Closure closure)` Returns a (possibly empty) list of all occurrences of a regular expression (in CharSequence format) found within a CharSequence.
`static List`	`findAll(CharSequence self, CharSequence regex)`
`static List`	`findAll(CharSequence self, CharSequence regex, Closure closure)` Returns a (possibly empty) list of all occurrences of a regular expression (in Pattern format) found within a CharSequence.
`static List`	`findAll(CharSequence self, Pattern pattern)`
`static List`	`findAll(CharSequence self, Pattern pattern, Closure closure)`
`static List`	`findAll(String self, Pattern pattern)`
`static List`	`findAll(String self, Pattern pattern, Closure closure)` Finds all occurrences of a compiled regular expression Pattern within a String.
`static List`	`findAll(String self, String regex)`
`static List`	`findAll(String self, String regex, Closure closure)`
`static CharSequence`	`getAt(CharSequence self, Collection indices)`
`static CharSequence`	`getAt(CharSequence text, EmptyRange range)` Support the range subscript operator for CharSequence or StringBuffer with EmptyRange
`static CharSequence`	`getAt(CharSequence text, int index)` Support the range subscript operator for CharSequence or StringBuffer with IntRange
`static CharSequence`	`getAt(CharSequence text, IntRange range)` Support the range subscript operator for CharSequence
`static CharSequence`	`getAt(CharSequence text, Range range)`
`static List`	`getAt(Matcher self, Collection indices)`
`static Object`	`getAt(Matcher matcher, int idx)`
`static String`	`getAt(String self, Collection indices)` Support the range subscript operator for String with EmptyRange
`static String`	`getAt(String text, EmptyRange range)` Support the subscript operator for String.
`static String`	`getAt(String text, int index)` Support the range subscript operator for String with IntRange
`static String`	`getAt(String text, IntRange range)` Support the range subscript operator for String
`static String`	`getAt(String text, Range range)`
`static char[]`	`getChars(CharSequence self)` Converts the given String into an array of characters.
`static char[]`	`getChars(String self)` Find the number of Strings matched to the given Matcher.
`static int`	`getCount(Matcher matcher)`
`static boolean`	`hasGroup(Matcher matcher)` Check whether a Matcher contains a group or not.
`static boolean`	`isAllWhitespace(CharSequence self)` True if a String only contains whitespace characters.
`static boolean`	`isAllWhitespace(String self)`
`static boolean`	`isBigDecimal(CharSequence self)` Determine if a String can be parsed into a BigDecimal.
`static boolean`	`isBigDecimal(String self)`
`static boolean`	`isBigInteger(CharSequence self)` Determine if a String can be parsed into a BigInteger.
`static boolean`	`isBigInteger(String self)`
`static boolean`	`isCase(CharSequence caseValue, Object switchValue)` 'Case' implementation for a GString, which simply calls the equivalent method for String.
`static boolean`	`isCase(GString caseValue, Object switchValue)`
`static boolean`	`isCase(Pattern caseValue, Object switchValue)`
`static boolean`	`isCase(String caseValue, Object switchValue)`
`static boolean`	`isDouble(CharSequence self)` Determine if a String can be parsed into a Double.
`static boolean`	`isDouble(String self)`
`static boolean`	`isFloat(CharSequence self)` Determine if a String can be parsed into a Float.
`static boolean`	`isFloat(String self)`
`static boolean`	`isInteger(CharSequence self)` Determine if a String can be parsed into an Integer.
`static boolean`	`isInteger(String self)`
`static boolean`	`isLong(CharSequence self)` Determine if a String can be parsed into a Long.
`static boolean`	`isLong(String self)`
`static boolean`	`isNumber(CharSequence self)` Determine if a String can be parsed into a Number.
`static boolean`	`isNumber(String self)` Returns an Iterator which traverses each match.
`static Iterator`	`iterator(Matcher matcher)`
`static StringBuilder`	`leftShift(CharSequence self, Object value)` Overloads the left shift operator to provide an easy way to append multiple objects as string representations to a CharSequence.
`static StringBuffer`	`leftShift(String self, Object value)`
`static StringBuffer`	`leftShift(StringBuffer self, Object value)` Overloads the left shift operator to provide syntactic sugar for appending to a StringBuilder.
`static StringBuilder`	`leftShift(StringBuilder self, Object value)` Tells whether or not a CharSequence matches the given compiled regular expression Pattern.
`static boolean`	`matches(CharSequence self, Pattern pattern)` Tells whether or not self matches the given compiled regular expression Pattern.
`static boolean`	`matches(String self, Pattern pattern)` Remove a part of a CharSequence by replacing the first occurrence of target within self with '' and returns the result.
`static boolean`	`matchesPartially(Matcher matcher)` Given a matcher that matches a string against a pattern, this method returns true when the string matches the pattern or if a longer string, could match the pattern.
`static CharSequence`	`minus(CharSequence self, Object target)` Remove a part of a String.
`static String`	`minus(String self, Pattern pattern)`
`static String`	`minus(String self, Object target)`
`static CharSequence`	`multiply(CharSequence self, Number factor)` Repeat a String a certain number of times.
`static String`	`multiply(String self, Number factor)`
`static CharSequence`	`next(CharSequence self)` This method is called by the ++ operator for the class String.
`static String`	`next(String self)`
`static CharSequence`	`normalize(CharSequence self)` Return a String with linefeeds and carriage returns normalized to linefeeds.
`static String`	`normalize(String self)`
`static CharSequence`	`padLeft(CharSequence self, Number numberOfChars)` Pad a CharSequence to a minimum length specified by `numberOfChars` by adding the space character to the left as many times as needed.
`static CharSequence`	`padLeft(CharSequence self, Number numberOfChars, CharSequence padding)`
`static String`	`padLeft(String self, Number numberOfChars)`
`static String`	`padLeft(String self, Number numberOfChars, String padding)` Pad a CharSequence to a minimum length specified by `numberOfChars` by adding the space character to the right as many times as needed.
`static CharSequence`	`padRight(CharSequence self, Number numberOfChars)` Pad a CharSequence to a minimum length specified by `numberOfChars`, adding the supplied padding CharSequence as many times as needed to the right.
`static CharSequence`	`padRight(CharSequence self, Number numberOfChars, CharSequence padding)`
`static String`	`padRight(String self, Number numberOfChars)`
`static String`	`padRight(String self, Number numberOfChars, String padding)` Appends the String representation of the given operand to this string.
`static CharSequence`	`plus(CharSequence left, Object value)` Appends a String to the string representation of this number.
`static String`	`plus(Number value, String right)`
`static String`	`plus(String left, Object value)`
`static String`	`plus(String left, CharSequence value)`
`static String`	`plus(StringBuffer left, String value)`
`static CharSequence`	`previous(CharSequence self)`
`static String`	`previous(String self)`
`static void`	`putAt(StringBuffer self, EmptyRange range, Object value)` Support the range subscript operator for StringBuffer.
`static void`	`putAt(StringBuffer self, IntRange range, Object value)` Return the lines of a CharSequence as a List of CharSequence.
`static List`	`readLines(CharSequence self)`
`static List`	`readLines(String self)`
`static CharSequence`	`replaceAll(CharSequence self, CharSequence regex, CharSequence replacement)` Replaces all occurrences of a captured group by the result of a closure on that text.
`static CharSequence`	`replaceAll(CharSequence self, CharSequence regex, Closure closure)` Replaces all substrings of a CharSequence that match the given compiled regular expression with the given replacement.
`static CharSequence`	`replaceAll(CharSequence self, Pattern pattern, CharSequence replacement)` Replaces all occurrences of a captured group by the result of a closure call on that text.
`static String`	`replaceAll(CharSequence self, Pattern pattern, Closure closure)`
`static String`	`replaceAll(String self, Pattern pattern, Closure closure)`
`static String`	`replaceAll(String self, Pattern pattern, String replacement)`
`static String`	`replaceAll(String self, String regex, Closure closure)` Replaces the first substring of this CharSequence that matches the given regular expression with the given replacement.
`static String`	`replaceFirst(CharSequence self, CharSequence regex, CharSequence replacement)` Replaces the first occurrence of a captured group by the result of a closure call on that text.
`static String`	`replaceFirst(CharSequence self, CharSequence regex, Closure closure)` Replaces the first substring of a CharSequence that matches the given compiled regular expression with the given replacement.
`static CharSequence`	`replaceFirst(CharSequence self, Pattern pattern, CharSequence replacement)` Replaces the first occurrence of a captured group by the result of a closure call on that text.
`static String`	`replaceFirst(CharSequence self, Pattern pattern, Closure closure)`
`static String`	`replaceFirst(String self, Pattern pattern, Closure closure)`
`static String`	`replaceFirst(String self, Pattern pattern, String replacement)`
`static String`	`replaceFirst(String self, String regex, Closure closure)` Creates a new CharSequence which is the reverse (backwards) of this string
`static CharSequence`	`reverse(CharSequence self)`
`static String`	`reverse(String self)`
`static void`	`setIndex(Matcher matcher, int idx)`
`static int`	`size(CharSequence text)` Provide the standard Groovy `size()` method for `CharSequence`.
`static long`	`size(Matcher self)`
`static int`	`size(String text)`
`static int`	`size(StringBuffer buffer)`
`static CharSequence[]`	`split(CharSequence self)`
`static String[]`	`split(GString self)`
`static String[]`	`split(String self)`
`static Object`	`splitEachLine(CharSequence self, CharSequence regex, Closure closure)` Iterates through the given CharSequence line by line, splitting each line using the given separator Pattern.
`static Object`	`splitEachLine(CharSequence self, Pattern pattern, Closure closure)` Iterates through the given String line by line, splitting each line using the given separator Pattern.
`static Object`	`splitEachLine(String self, Pattern pattern, Closure closure)`
`static Object`	`splitEachLine(String self, String regex, Closure closure)` Strip leading spaces from every line in a CharSequence.
`static CharSequence`	`stripIndent(CharSequence self)` Strip `numChar` leading characters from every line in a CharSequence.
`static CharSequence`	`stripIndent(CharSequence self, int numChars)`
`static String`	`stripIndent(String self)`
`static String`	`stripIndent(String self, int numChars)`
`static CharSequence`	`stripMargin(CharSequence self)`
`static CharSequence`	`stripMargin(CharSequence self, char marginChar)`
`static String`	`stripMargin(CharSequence self, CharSequence marginChar)`
`static String`	`stripMargin(String self)`
`static String`	`stripMargin(String self, char marginChar)`
`static String`	`stripMargin(String self, String marginChar)`
`static CharSequence`	`take(CharSequence self, int num)`
`static CharSequence`	`takeWhile(CharSequence self, Closure condition)` Parse a CharSequence into a BigDecimal
`static BigDecimal`	`toBigDecimal(CharSequence self)` Parse a CharSequence into a BigInteger
`static BigDecimal`	`toBigDecimal(String self)` Parse a String into a BigInteger
`static BigInteger`	`toBigInteger(CharSequence self)` Converts the given string into a Boolean object.
`static BigInteger`	`toBigInteger(String self)`
`static Boolean`	`toBoolean(String self)`
`static Character`	`toCharacter(String self)` Parse a String into a Double
`static Double`	`toDouble(CharSequence self)` Parse a CharSequence into a Float
`static Double`	`toDouble(String self)` Parse a String into a Float
`static Float`	`toFloat(CharSequence self)` Parse a CharSequence into an Integer
`static Float`	`toFloat(String self)` Parse a String into an Integer
`static Integer`	`toInteger(CharSequence self)` Tokenize a CharSequence (with a whitespace as the delimiter).
`static Integer`	`toInteger(String self)` Tokenize a CharSequence based on the given character delimiter.
`static List`	`toList(CharSequence self)`
`static List`	`toList(String self)`
`static Long`	`toLong(CharSequence self)` Converts the given CharSequence into a Set of unique CharSequence of one character.
`static Long`	`toLong(String self)`
`static Set`	`toSet(CharSequence self)`
`static Set`	`toSet(String self)` Parse a String into a Short
`static Short`	`toShort(CharSequence self)` Translates a string by replacing characters from the sourceSet with characters from replacementSet.
`static Short`	`toShort(String self)`
`static List`	`tokenize(CharSequence self)` Tokenize a CharSequence based on the given CharSequence delimiter.
`static List`	`tokenize(CharSequence self, Character token)` Tokenize a String (with a whitespace as the delimiter).
`static List`	`tokenize(CharSequence self, CharSequence token)`
`static List`	`tokenize(String self)`
`static List`	`tokenize(String self, Character token)` Converts the given CharSequence into a List of CharSequence of one character.
`static List`	`tokenize(String self, String token)` Converts the given String into a List of strings of one character.
`static CharSequence`	`tr(CharSequence self, CharSequence sourceSet, CharSequence replacementSet)`
`static String`	`tr(String self, String sourceSet, String replacementSet)` Replaces sequences of whitespaces with tabs using tabStops of size 8.
`static CharSequence`	`unexpand(CharSequence self)` Replaces sequences of whitespaces with tabs using tabStops of size 8.
`static CharSequence`	`unexpand(CharSequence self, int tabStop)` Replaces sequences of whitespaces with tabs.
`static String`	`unexpand(String self)`
`static String`	`unexpand(String self, int tabStop)`
`static CharSequence`	`unexpandLine(CharSequence self, int tabStop)` Replaces sequences of whitespaces with tabs within a line.
`static String`	`unexpandLine(String self, int tabStop)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class DefaultGroovyMethodsSupport`	`cloneSimilarCollection, cloneSimilarMap, closeQuietly, closeWithWarning, createSimilarArray, createSimilarCollection, createSimilarCollection, createSimilarList, createSimilarMap, createSimilarOrDefaultCollection, createSimilarSet, normaliseIndex, sameType, subListBorders, subListBorders`
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Method Detail
  - public static boolean asBoolean(CharSequence string)
    
    Coerce a string (an instance of CharSequence) to a boolean value. A string is coerced to false if it is of length 0, and to true otherwise.
    Parameters:
    string - the character sequence
    Returns:
    the boolean value
    Since:
    1.7.0
  - public static boolean asBoolean(Matcher matcher)
    
    Coerce a Matcher instance to a boolean value.
    Parameters:
    matcher - the matcher
    Returns:
    the boolean value
    Since:
    1.7.0
  - public static Object asType(CharSequence self, Class c)
    
    Provides a method to perform custom 'dynamic' type conversion to the given class using the as operator.
    Parameters:
    self - a CharSequence
    c - the desired class
    Returns:
    the converted object
    See Also:
    asType(String, Class)
    Since:
    1.8.2
  - @SuppressWarnings("unchecked") public static Object asType(GString self, Class c)
    
    Converts the GString to a File, or delegates to the default DefaultGroovyMethods.asType
    Parameters:
    self - a GString
    c - the desired class
    Returns:
    the converted object
    Since:
    1.5.0
  - @SuppressWarnings("unchecked") public static Object asType(String self, Class c)
    
    Provides a method to perform custom 'dynamic' type conversion to the given class using the as operator. Example: '123' as Double
    By default, the following types are supported:
    - List
    - BigDecimal
    - BigInteger
    - Long
    - Integer
    - Short
    - Byte
    - Character
    - Double
    - Float
    - File
    - Subclasses of Enum (Java 5 and above)
    If any other type is given, the call is delegated to DefaultGroovyMethods.asType.
    Parameters:
    self - a String
    c - the desired class
    Returns:
    the converted object
    Since:
    1.0
  - public static Pattern bitwiseNegate(CharSequence self)
    
    Turns a CharSequence into a regular expression Pattern
    Parameters:
    self - a String to convert into a regular expression
    Returns:
    the regular expression pattern
    Since:
    1.8.2
  - public static Pattern bitwiseNegate(String self)
    
    Turns a String into a regular expression Pattern
    Parameters:
    self - a String to convert into a regular expression
    Returns:
    the regular expression pattern
    Since:
    1.5.0
  - public static CharSequence capitalize(CharSequence self)
    
    Convenience method to capitalize the first letter of a CharSequence.
    Parameters:
    self - The CharSequence to capitalize
    Returns:
    The capitalized CharSequence
    See Also:
    capitalize(String)
    Since:
    1.8.2
  - public static String capitalize(String self)
    
    Convenience method to capitalize the first letter of a string (typically the first letter of a word). Example usage:
```
 assert 'h'.capitalize() == 'H'
 assert 'hello'.capitalize() == 'Hello'
 assert 'hello world'.capitalize() == 'Hello world'
 assert 'Hello World' ==
     'hello world'.split(' ').collect{ it.capitalize() }.join(' ')
 
```
    Parameters:
    self - The string to capitalize
    Returns:
    The capitalized String
    Since:
    1.7.3
  - public static CharSequence center(CharSequence self, Number numberOfChars)
    
    Pad a CharSequence to a minimum length specified by numberOfChars by adding the space character around it as many times as needed so that it remains centered.
    Parameters:
    self - a CharSequence object
    numberOfChars - the total minimum number of characters of the resulting CharSequence
    Returns:
    the CharSequence centered with padded characters around it
    See Also:
    center(String, Number)
    Since:
    1.8.2
  - public static CharSequence center(CharSequence self, Number numberOfChars, CharSequence padding)
    
    Pad a CharSequence to a minimum length specified by numberOfChars, appending the supplied padding CharSequence around the original as many times as needed keeping it centered.
    Parameters:
    self - a CharSequence object
    numberOfChars - the total minimum number of characters of the resulting CharSequence
    padding - the characters used for padding
    Returns:
    the CharSequence centered with padded characters around it
    See Also:
    center(String, Number, String)
    Since:
    1.8.2
  - public static String center(String self, Number numberOfChars)
    
    Pad a String to a minimum length specified by numberOfChars by adding the space character around it as many times as needed so that it remains centered. If the String is already the same size or bigger than the target numberOfChars, then the original String is returned. An example:
```
 ['A', 'BB', 'CCC', 'DDDD'].each{ println '|' + it.center(6) + '|' }
 
```
    will produce output like:
```
 |  A   |
 |  BB  |
 | CCC  |
 | DDDD |
 
```
    Parameters:
    self - a String object
    numberOfChars - the total minimum number of characters of the resulting string
    Returns:
    the String centered with padded characters around it
    See Also:
    center(String, Number, String)
    Since:
    1.0
  - public static String center(String self, Number numberOfChars, String padding)
    
    Pad a String to a minimum length specified by numberOfChars, appending the supplied padding String around the original as many times as needed keeping it centered. If the String is already the same size or bigger than the target numberOfChars, then the original String is returned. An example:
```
 ['A', 'BB', 'CCC', 'DDDD'].each{ println '|' + it.center(6, '+') + '|' }
 
```
    will produce output like:
```
 |++A+++|
 |++BB++|
 |+CCC++|
 |+DDDD+|
 
```
    Parameters:
    self - a String object
    numberOfChars - the total minimum number of characters of the resulting string
    padding - the characters used for padding
    Returns:
    the String centered with padded characters around it
    Since:
    1.0
  - public static String collectReplacements(String orig, @ClosureParamsour local buffer Closure transform)
    
    Iterate through this String a character at a time collecting either the original character or a transformed replacement String. The transform Closure should return null to indicate that no transformation is required for the given character.
```
 assert "Groovy".collectReplacements{ it == 'o' ? '_O_' : null } == 'Gr_O__O_vy'
 assert "B&W".collectReplacements{ it == '&' ? '&' : null } == 'B&W'
 
```
    Parameters:
    orig - the original String
    Returns:
    A new string in which all characters that require escaping have been replaced with the corresponding replacements as determined by the transform Closure.
  - public static boolean contains(CharSequence self, CharSequence text)
    
    Provide an implementation of contains() like Collection.contains to make CharSequences more polymorphic.
    Parameters:
    self - a CharSequence
    text - the CharSequence to look for
    Returns:
    true if this CharSequence contains the given text
    See Also:
    contains(String, String)
    Since:
    1.8.2
  - public static boolean contains(String self, String text)
    
    Provide an implementation of contains() like Collection.contains to make Strings more polymorphic. This method is not required on JDK 1.5 onwards
    Parameters:
    self - a String
    text - a String to look for
    Returns:
    true if this string contains the given text
    Since:
    1.0
  - public static int count(CharSequence self, CharSequence text)
    
    Count the number of occurrences of a sub CharSequence.
    Parameters:
    self - a CharSequence
    text - a sub CharSequence
    Returns:
    the number of occurrences of the given CharSequence inside this CharSequence
    See Also:
    count(String, String)
    Since:
    1.8.2
  - public static int count(String self, String text)
    
    Count the number of occurrences of a substring.
    Parameters:
    self - a String
    text - a substring
    Returns:
    the number of occurrences of the given string inside this String
    Since:
    1.0
  - public static CharSequence denormalize(CharSequence self)
    
    Return a CharSequence with lines (separated by LF, CR/LF, or CR) terminated by the platform specific line separator.
    Parameters:
    self - a CharSequence object
    Returns:
    the denormalized CharSequence
    See Also:
    denormalize(String)
    Since:
    1.8.2
  - public static String denormalize(String self)
    
    Return a String with lines (separated by LF, CR/LF, or CR) terminated by the platform specific line separator.
    Parameters:
    self - a String object
    Returns:
    the denormalized string
    Since:
    1.6.0
  - public static CharSequence drop(CharSequence self, int num)
    
    Drops the given number of chars from the head of this CharSequence if they are available.
```
     def text = "Groovy"
     assert text.drop( 0 ) == 'Groovy'
     assert text.drop( 2 ) == 'oovy'
     assert text.drop( 7 ) == ''
 
```
    Parameters:
    self - the original CharSequence
    num - the number of characters to drop from this iterator
    Returns:
    a CharSequence consisting of all characters except the first num ones, or else an empty String, if this CharSequence has less than num characters.
    Since:
    1.8.1
  - public static CharSequence dropWhile(CharSequence self, @ClosureParams Closure condition)
    
    Create a suffix of the given CharSequence by dropping as many characters as possible from the front of the original CharSequence such that calling the given closure condition evaluates to true when passed each of the dropped characters.
```
 def text = "Groovy"
 assert text.dropWhile{ false } == 'Groovy'
 assert text.dropWhile{ true } == ''
 assert text.dropWhile{ it < 'Z' } == 'roovy'
 assert text.dropWhile{ it != 'v' } == 'vy'
 
```
    Parameters:
    self - the original CharSequence
    condition - the closure that while continuously evaluating to true will cause us to drop elements from the front of the original CharSequence
    Returns:
    the shortest suffix of the given CharSequence such that the given closure condition evaluates to true for each element dropped from the front of the CharSequence
    Since:
    2.0.0
  - public static Object eachLine(CharSequence self, @ClosureParams Closure closure)
    
    Iterates through this CharSequence line by line. Each line is passed to the given 1 or 2 arg closure. If a 2 arg closure is found the line count is passed as the second argument.
    throws:
    java.io.IOException if an error occurs
    
    Parameters:
    self - a CharSequence
    closure - a closure
    Returns:
    the last value returned by the closure
    See Also:
    eachLine(String, groovy.lang.Closure)
    Since:
    1.8.2
  - public static Object eachLine(CharSequence self, int firstLine, @ClosureParams Closure closure)
  - public static Object eachLine(String self, @ClosureParams Closure closure)
  - public static Object eachLine(String self, int firstLine, @ClosureParams Closure closure)
  - public static String eachMatch(CharSequence self, CharSequence regex, @ClosureParamss groups Closure closure)
    
    Process each regex group matched substring of the given CharSequence. If the closure parameter takes one argument, an array with all match groups is passed to it. If the closure takes as many arguments as there are match groups, then each parameter will be one match group.
    Parameters:
    self - the source CharSequence
    regex - a Regex CharSequence
    closure - a closure with one parameter or as much parameters as groups
    Returns:
    the source CharSequence
    See Also:
    eachMatch(String, String, groovy.lang.Closure)
    Since:
    1.8.2
  - public static String eachMatch(CharSequence self, Pattern pattern, @ClosureParamss as groups Closure closure)
  - public static String eachMatch(String self, Pattern pattern, @ClosureParams Closure closure)
  - public static String eachMatch(String self, String regex, @ClosureParams Closure closure)
    
    Expands all tabs into spaces with tabStops of size 8.
    Parameters:
    self - A CharSequence to expand
    Returns:
    The expanded CharSequence
    See Also:
    expand(String)
    Since:
    1.8.2
  - public static CharSequence expand(CharSequence self)
  - public static CharSequence expand(CharSequence self, int tabStop)
    
    Expands all tabs into spaces with tabStops of size 8.
    Parameters:
    self - A String to expand
    Returns:
    The expanded String
    See Also:
    expand(String, int)
    Since:
    1.7.3
  - public static String expand(String self)
  - public static String expand(String self, int tabStop)
  - public static CharSequence expandLine(CharSequence self, int tabStop)
    
    Expands all tabs into spaces. Assumes the CharSequence represents a single line of text.
    Parameters:
    self - A line to expand
    tabStop - The number of spaces a tab represents
    Returns:
    The expanded CharSequence
    See Also:
    expandLine(String, int)
    Since:
    1.8.2
  - public static String expandLine(String self, int tabStop)
  - public static CharSequence find(CharSequence self, CharSequence regex)
  - public static CharSequence find(CharSequence self, CharSequence regex, @ClosureParams Closure closure)
    
    Finds the first occurrence of a compiled regular expression Pattern within a CharSequence.
    Parameters:
    self - a CharSequence
    pattern - the compiled regex Pattern
    Returns:
    a CharSequence containing the matched portion, or null if the regex pattern doesn't match
    See Also:
    find(String, java.util.regex.Pattern)
    Since:
    1.8.2
  - public static CharSequence find(CharSequence self, Pattern pattern)
  - public static CharSequence find(CharSequence self, Pattern pattern, @ClosureParams Closure closure)
  - public static String find(String self, Pattern pattern)
  - public static String find(String self, Pattern pattern, @ClosureParams Closure closure)
  - public static String find(String self, String regex)
    
    Finds the first occurrence of a regular expression String within a String. If the regex doesn't match, null will be returned.
    For example, if the regex doesn't match the result is null:
```
     assert null == "New York, NY".find(/\d{5}/)
 
```
    If it does match, we get the matching string back:
```
      assert "10292" == "New York, NY 10292-0098".find(/\d{5}/)
 
```
    If we have capture groups in our expression, we still get back the full match
```
      assert "10292-0098" == "New York, NY 10292-0098".find(/(\d{5})-?(\d{4})/)
 
```
    Parameters:
    self - a String
    regex - the capturing regex
    Returns:
    a String containing the matched portion, or null if the regex doesn't match
    Since:
    1.6.1
  - public static String find(String self, String regex, @ClosureParamsself, CharSequence regex) { Closure closure)
    
    Returns a (possibly empty) list of all occurrences of a regular expression (in CharSequence format) found within a CharSequence.
    Parameters:
    self - a CharSequence
    regex - the capturing regex CharSequence
    Returns:
    a List containing all full matches of the regex within the CharSequence, an empty list will be returned if there are no matches
    See Also:
    findAll(String, String)
    Since:
    1.8.2
  - public static List findAll(CharSequence self, CharSequence regex)
  - public static List findAll(CharSequence self, CharSequence regex, Closure closure)
    
    Returns a (possibly empty) list of all occurrences of a regular expression (in Pattern format) found within a CharSequence.
    Parameters:
    self - a CharSequence
    pattern - the compiled regex Pattern
    Returns:
    a List containing all full matches of the Pattern within the CharSequence, an empty list will be returned if there are no matches
    See Also:
    findAll(String, java.util.regex.Pattern)
    Since:
    1.8.2
  - public static List findAll(CharSequence self, Pattern pattern)
  - public static List findAll(CharSequence self, Pattern pattern, @ClosureParams Closure closure)
  - public static List findAll(String self, Pattern pattern)
  - public static List findAll(String self, Pattern pattern, @ClosureParams Closure closure)
    
    Finds all occurrences of a compiled regular expression Pattern within a String. Any matches are passed to the specified closure. The closure is expected to have the full match in the first parameter. If there are any capture groups, they will be placed in subsequent parameters.
    If there are no matches, the closure will not be called, and an empty List will be returned.
    For example, if the pattern doesn't match, it returns an empty list:
```
 assert [] == "foo".findAll(~/(\w*) Fish/) { match, firstWord -> return firstWord }
 
```
    Any regular expression matches are passed to the closure, if there are no capture groups, there will be one parameter for the match:
```
 assert ["couldn't", "wouldn't"] == "I could not, would not, with a fox.".findAll(~/.ould/) { match -> "${match}n't"}
 
```
    If there are capture groups, the first parameter will be the match followed by one parameter for each capture group:
```
 def orig = "There's a Wocket in my Pocket"
 assert ["W > Wocket", "P > Pocket"] == orig.findAll(~/(.)ocket/) { match, firstLetter -> "$firstLetter > $match" }
 
```
    Parameters:
    self - a String
    pattern - the compiled regex Pattern
    closure - will be passed the full match plus each of the capturing groups
    Returns:
    a List containing all full matches of the regex Pattern within the string, an empty list will be returned if there are no matches
    Since:
    1.6.1
  - public static List findAll(String self, String regex)
  - public static List findAll(String self, String regex, @ClosureParamsllection Closure closure)
  - public static CharSequence getAt(CharSequence self, Collection indices)
  - public static CharSequence getAt(CharSequence text, EmptyRange range)
    
    Support the range subscript operator for CharSequence or StringBuffer with EmptyRange
    Parameters:
    text - a CharSequence
    range - an EmptyRange
    Returns:
    the subsequence CharSequence
    Since:
    1.5.0
  - public static CharSequence getAt(CharSequence text, int index)
    
    Support the range subscript operator for CharSequence or StringBuffer with IntRange
    Parameters:
    text - a CharSequence
    range - an IntRange
    Returns:
    the subsequence CharSequence
    Since:
    1.0
  - public static CharSequence getAt(CharSequence text, IntRange range)
    
    Support the range subscript operator for CharSequence
    Parameters:
    text - a CharSequence
    range - a Range
    Returns:
    the subsequence CharSequence
    Since:
    1.0
  - public static CharSequence getAt(CharSequence text, Range range)
  - public static List getAt(Matcher self, Collection indices)
  - public static Object getAt(Matcher matcher, int idx)
  - public static String getAt(String self, Collection indices)
    
    Support the range subscript operator for String with EmptyRange
    Parameters:
    text - a String
    range - an EmptyRange
    Returns:
    the resulting String
    Since:
    1.5.0
  - public static String getAt(String text, EmptyRange range)
    
    Support the subscript operator for String.
    Parameters:
    text - a String
    index - the index of the Character to get
    Returns:
    the Character at the given index
    Since:
    1.0
  - public static String getAt(String text, int index)
    
    Support the range subscript operator for String with IntRange
    Parameters:
    text - a String
    range - an IntRange
    Returns:
    the resulting String
    Since:
    1.0
  - public static String getAt(String text, IntRange range)
    
    Support the range subscript operator for String
    Parameters:
    text - a String
    range - a Range
    Returns:
    a substring corresponding to the Range
    Since:
    1.0
  - public static String getAt(String text, Range range)
  - public static char[] getChars(CharSequence self)
    
    Converts the given String into an array of characters. Alias for toCharArray.
    Parameters:
    self - a String
    Returns:
    an array of characters
    See Also:
    String.toCharArray
    Since:
    1.6.0
  - public static char[] getChars(String self)
    
    Find the number of Strings matched to the given Matcher.
    Parameters:
    matcher - a Matcher
    Returns:
    int the number of Strings matched to the given matcher.
    Since:
    1.0
  - public static int getCount(Matcher matcher)
  - public static boolean hasGroup(Matcher matcher)
    
    Check whether a Matcher contains a group or not.
    Parameters:
    matcher - a Matcher
    Returns:
    boolean true if matcher contains at least one group.
    Since:
    1.0
  - public static boolean isAllWhitespace(CharSequence self)
    
    True if a String only contains whitespace characters.
    Parameters:
    self - The String to check the characters in
    Returns:
    true If all characters are whitespace characters
    See Also:
    Character.isWhitespace
    Since:
    1.6
  - public static boolean isAllWhitespace(String self)
  - public static boolean isBigDecimal(CharSequence self)
    
    Determine if a String can be parsed into a BigDecimal.
    Parameters:
    self - a String
    Returns:
    true if the string can be parsed
    Since:
    1.5.0
  - public static boolean isBigDecimal(String self)
  - public static boolean isBigInteger(CharSequence self)
    
    Determine if a String can be parsed into a BigInteger.
    Parameters:
    self - a String
    Returns:
    true if the string can be parsed
    Since:
    1.5.0
  - public static boolean isBigInteger(String self)
  - public static boolean isCase(CharSequence caseValue, Object switchValue)
    
    'Case' implementation for a GString, which simply calls the equivalent method for String.
    Parameters:
    caseValue - the case value
    switchValue - the switch value
    Returns:
    true if the switchValue's toString() equals the caseValue
    Since:
    1.6.0
  - public static boolean isCase(GString caseValue, Object switchValue)
  - public static boolean isCase(Pattern caseValue, Object switchValue)
  - public static boolean isCase(String caseValue, Object switchValue)
  - public static boolean isDouble(CharSequence self)
    
    Determine if a String can be parsed into a Double.
    Parameters:
    self - a String
    Returns:
    true if the string can be parsed
    Since:
    1.5.0
  - public static boolean isDouble(String self)
  - public static boolean isFloat(CharSequence self)
    
    Determine if a String can be parsed into a Float.
    Parameters:
    self - a String
    Returns:
    true if the string can be parsed
    Since:
    1.5.0
  - public static boolean isFloat(String self)
  - public static boolean isInteger(CharSequence self)
    
    Determine if a String can be parsed into an Integer.
    Parameters:
    self - a String
    Returns:
    true if the string can be parsed
    Since:
    1.5.0
  - public static boolean isInteger(String self)
  - public static boolean isLong(CharSequence self)
    
    Determine if a String can be parsed into a Long.
    Parameters:
    self - a String
    Returns:
    true if the string can be parsed
    Since:
    1.5.0
  - public static boolean isLong(String self)
  - public static boolean isNumber(CharSequence self)
    
    Determine if a String can be parsed into a Number. Synonym for 'isBigDecimal()'.
    Parameters:
    self - a String
    Returns:
    true if the string can be parsed
    See Also:
    isBigDecimal(String)
    Since:
    1.5.0
  - public static boolean isNumber(String self)
    
    Returns an Iterator which traverses each match.
    Parameters:
    matcher - a Matcher object
    Returns:
    an Iterator for a Matcher
    See Also:
    Matcher.group
    Since:
    1.0
  - public static Iterator iterator(Matcher matcher)
  - public static StringBuilder leftShift(CharSequence self, Object value)
    
    Overloads the left shift operator to provide an easy way to append multiple objects as string representations to a CharSequence.
    Parameters:
    self - a CharSequence
    value - an Object
    Returns:
    a StringBuilder built from this CharSequence
    Since:
    1.8.2
  - public static StringBuffer leftShift(String self, Object value)
  - public static StringBuffer leftShift(StringBuffer self, Object value)
    
    Overloads the left shift operator to provide syntactic sugar for appending to a StringBuilder.
    Parameters:
    self - a StringBuilder
    value - an Object
    Returns:
    the original StringBuilder
    Since:
    1.8.2
  - public static StringBuilder leftShift(StringBuilder self, Object value)
    
    Tells whether or not a CharSequence matches the given compiled regular expression Pattern.
    Parameters:
    self - the CharSequence that is to be matched
    pattern - the regex Pattern to which the string of interest is to be matched
    Returns:
    true if the CharSequence matches
    See Also:
    String.matches
    Since:
    1.8.2
  - public static boolean matches(CharSequence self, Pattern pattern)
    
    Tells whether or not self matches the given compiled regular expression Pattern.
    Parameters:
    self - the string that is to be matched
    pattern - the regex Pattern to which the string of interest is to be matched
    Returns:
    true if the string matches
    See Also:
    String.matches
    Since:
    1.6.1
  - public static boolean matches(String self, Pattern pattern)
    
    Remove a part of a CharSequence by replacing the first occurrence of target within self with '' and returns the result.
    Parameters:
    self - a CharSequence
    target - an object representing the part to remove
    Returns:
    a CharSequence minus the part to be removed
    See Also:
    minus(String, Object)
    Since:
    1.8.2
  - public static boolean matchesPartially(Matcher matcher)
    
    Given a matcher that matches a string against a pattern, this method returns true when the string matches the pattern or if a longer string, could match the pattern. For example:
```
     def emailPattern = /\w+@\w+\.\w{2,}/

     def matcher = "john@doe" =~ emailPattern
     assert matcher.matchesPartially()

     matcher = "john@doe.com" =~ emailPattern
     assert matcher.matchesPartially()

     matcher = "john@@" =~ emailPattern
     assert !matcher.matchesPartially()
 
```
    Parameters:
    matcher - the Matcher
    Returns:
    true if more input to the String could make the matcher match the associated pattern, false otherwise.
    Since:
    2.0.0
  - public static CharSequence minus(CharSequence self, Object target)
    
    Remove a part of a String. This replaces the first occurrence of the regex pattern within self with '' and returns the result.
    Parameters:
    self - a String
    pattern - a Pattern representing the part to remove
    Returns:
    a String minus the part to be removed
    Since:
    2.2.0
  - public static String minus(String self, Pattern pattern)
  - public static String minus(String self, Object target)
  - public static CharSequence multiply(CharSequence self, Number factor)
    
    Repeat a String a certain number of times.
    throws:
    IllegalArgumentException if the number of repetitions is < 0
    
    Parameters:
    self - a String to be repeated
    factor - the number of times the String should be repeated
    Returns:
    a String composed of a repetition
    Since:
    1.0
  - public static String multiply(String self, Number factor)
  - public static CharSequence next(CharSequence self)
    
    This method is called by the ++ operator for the class String. It increments the last character in the given string. If the character in the string is Character.MAX_VALUE a Character.MIN_VALUE will be appended. The empty string is incremented to a string consisting of the character Character.MIN_VALUE.
    Parameters:
    self - a String
    Returns:
    an incremented String
    Since:
    1.0
  - public static String next(String self)
  - public static CharSequence normalize(CharSequence self)
    
    Return a String with linefeeds and carriage returns normalized to linefeeds.
    Parameters:
    self - a String object
    Returns:
    the normalized string
    Since:
    1.6.0
  - public static String normalize(String self)
  - public static CharSequence padLeft(CharSequence self, Number numberOfChars)
    
    Pad a CharSequence to a minimum length specified by numberOfChars by adding the space character to the left as many times as needed.
    Parameters:
    self - a CharSequence object
    numberOfChars - the total minimum number of characters of the resulting CharSequence
    Returns:
    the CharSequence padded to the left
    See Also:
    padLeft(CharSequence, Number, CharSequence)
    Since:
    1.8.2
  - public static CharSequence padLeft(CharSequence self, Number numberOfChars, CharSequence padding)
  - public static String padLeft(String self, Number numberOfChars)
  - public static String padLeft(String self, Number numberOfChars, String padding)
    
    Pad a CharSequence to a minimum length specified by numberOfChars by adding the space character to the right as many times as needed.
    Parameters:
    self - a CharSequence object
    numberOfChars - the total minimum number of characters of the resulting string
    Returns:
    the CharSequence padded to the right
    See Also:
    padRight(String, Number)
    Since:
    1.8.2
  - public static CharSequence padRight(CharSequence self, Number numberOfChars)
    
    Pad a CharSequence to a minimum length specified by numberOfChars, adding the supplied padding CharSequence as many times as needed to the right.
    Parameters:
    self - a CharSequence object
    numberOfChars - the total minimum number of characters of the resulting CharSequence
    padding - the characters used for padding
    Returns:
    the CharSequence padded to the right
    See Also:
    padRight(String, Number, String)
    Since:
    1.8.2
  - public static CharSequence padRight(CharSequence self, Number numberOfChars, CharSequence padding)
  - public static String padRight(String self, Number numberOfChars)
  - public static String padRight(String self, Number numberOfChars, String padding)
    
    Appends the String representation of the given operand to this string.
    Parameters:
    left - a CharSequence
    value - any Object
    Returns:
    the new CharSequence with the object appended
    Since:
    1.8.2
  - public static CharSequence plus(CharSequence left, Object value)
    
    Appends a String to the string representation of this number.
    Parameters:
    value - a Number
    right - a String
    Returns:
    a String
    Since:
    1.0
  - public static String plus(Number value, String right)
  - public static String plus(String left, Object value)
  - public static String plus(String left, CharSequence value)
  - public static String plus(StringBuffer left, String value)
  - public static CharSequence previous(CharSequence self)
  - public static String previous(String self)
  - public static void putAt(StringBuffer self, EmptyRange range, Object value)
    
    Support the range subscript operator for StringBuffer. Index values are treated as characters within the buffer.
    Parameters:
    self - a StringBuffer
    range - a Range
    value - the object that's toString() will be inserted
    Since:
    1.0
  - public static void putAt(StringBuffer self, IntRange range, Object value)
    
    Return the lines of a CharSequence as a List of CharSequence.
    throws:
    java.io.IOException if an error occurs
    
    Parameters:
    self - a CharSequence object
    Returns:
    a list of lines
    Since:
    1.8.2
  - public static List readLines(CharSequence self)
  - public static List readLines(String self)
  - public static CharSequence replaceAll(CharSequence self, CharSequence regex, CharSequence replacement)
    
    Replaces all occurrences of a captured group by the result of a closure on that text.
    throws:
    java.util.regex.PatternSyntaxException if the regular expression's syntax is invalid
    
    Parameters:
    self - a CharSequence
    regex - the capturing regex
    closure - the closure to apply on each captured group
    Returns:
    a CharSequence with replaced content
    See Also:
    replaceAll(String, java.util.regex.Pattern, groovy.lang.Closure)
    Since:
    1.8.2
  - public static CharSequence replaceAll(CharSequence self, CharSequence regex, @ClosureParams Closure closure)
    
    Replaces all substrings of a CharSequence that match the given compiled regular expression with the given replacement.
    Parameters:
    self - the CharSequence that is to be matched
    pattern - the regex Pattern to which the CharSequence of interest is to be matched
    replacement - the CharSequence to be substituted for the first match
    Returns:
    The resulting CharSequence
    See Also:
    replaceAll(String, java.util.regex.Pattern, String)
    Since:
    1.8.2
  - public static CharSequence replaceAll(CharSequence self, Pattern pattern, @ClosureParamscall on that text. CharSequence replacement)
    
    Replaces all occurrences of a captured group by the result of a closure call on that text.
    Parameters:
    self - a CharSequence
    pattern - the capturing regex Pattern
    closure - the closure to apply on each captured group
    Returns:
    a CharSequence with replaced content
    See Also:
    replaceAll(String, java.util.regex.Pattern, groovy.lang.Closure)
    Since:
    1.8.2
  - public static String replaceAll(CharSequence self, Pattern pattern, @ClosureParams Closure closure)
  - public static String replaceAll(String self, Pattern pattern, @ClosureParams Closure closure)
  - public static String replaceAll(String self, Pattern pattern, @ClosureParams String replacement)
  - public static String replaceAll(String self, String regex, @ClosureParams Closure closure)
    
    Replaces the first substring of this CharSequence that matches the given regular expression with the given replacement.
    throws:
    java.util.regex.PatternSyntaxException if the regular expression's syntax is invalid
    
    Parameters:
    self - a CharSequence
    regex - the capturing regex
    replacement - the capturing regex
    Returns:
    a CharSequence with replaced content
    See Also:
    String.replaceAll
    Since:
    1.8.2
  - public static String replaceFirst(CharSequence self, CharSequence regex, CharSequence replacement)
    
    Replaces the first occurrence of a captured group by the result of a closure call on that text.
    throws:
    java.util.regex.PatternSyntaxException if the regular expression's syntax is invalid
    
    Parameters:
    self - a CharSequence
    regex - the capturing regex
    closure - the closure to apply on the first captured group
    Returns:
    a CharSequence with replaced content
    See Also:
    replaceFirst(String, String, groovy.lang.Closure)
    Since:
    1.8.2
  - public static String replaceFirst(CharSequence self, CharSequence regex, @ClosureParams Closure closure)
    
    Replaces the first substring of a CharSequence that matches the given compiled regular expression with the given replacement.
    Parameters:
    self - the CharSequence that is to be matched
    pattern - the regex Pattern to which the CharSequence of interest is to be matched
    replacement - the CharSequence to be substituted for the first match
    Returns:
    The resulting CharSequence
    See Also:
    replaceFirst(String, java.util.regex.Pattern, String)
    Since:
    1.8.2
  - public static CharSequence replaceFirst(CharSequence self, Pattern pattern, CharSequence replacement)
    
    Replaces the first occurrence of a captured group by the result of a closure call on that text.
    Parameters:
    self - a CharSequence
    pattern - the capturing regex Pattern
    closure - the closure to apply on the first captured group
    Returns:
    a CharSequence with replaced content
    See Also:
    replaceFirst(String, java.util.regex.Pattern, groovy.lang.Closure)
    Since:
    1.8.2
  - public static String replaceFirst(CharSequence self, Pattern pattern, @ClosureParams Closure closure)
  - public static String replaceFirst(String self, Pattern pattern, @ClosureParams Closure closure)
  - public static String replaceFirst(String self, Pattern pattern, String replacement)
  - public static String replaceFirst(String self, String regex, @ClosureParams Closure closure)
    
    Creates a new CharSequence which is the reverse (backwards) of this string
    Parameters:
    self - a CharSequence
    Returns:
    a new CharSequence with all the characters reversed.
    See Also:
    reverse(String)
    Since:
    1.8.2
  - public static CharSequence reverse(CharSequence self)
  - public static String reverse(String self)
  - public static void setIndex(Matcher matcher, int idx)
  - public static int size(CharSequence text)
    
    Provide the standard Groovy size() method for CharSequence.
    Parameters:
    text - a CharSequence
    Returns:
    the length of the CharSequence
    Since:
    1.8.2
  - public static long size(Matcher self)
  - public static int size(String text)
  - public static int size(StringBuffer buffer)
  - public static CharSequence[] split(CharSequence self)
  - public static String[] split(GString self)
  - public static String[] split(String self)
  - public static Object splitEachLine(CharSequence self, CharSequence regex, @ClosureParams Closure closure)
    
    Iterates through the given CharSequence line by line, splitting each line using the given separator Pattern. The list of tokens for each line is then passed to the given closure.
    throws:
    java.io.IOException if an error occurs
    
    Parameters:
    self - a CharSequence
    pattern - the regular expression Pattern for the delimiter
    closure - a closure
    Returns:
    the last value returned by the closure
    See Also:
    splitEachLine(String, java.util.regex.Pattern, groovy.lang.Closure)
    Since:
    1.8.2
  - public static Object splitEachLine(CharSequence self, Pattern pattern, @ClosureParams Closure closure)
    
    Iterates through the given String line by line, splitting each line using the given separator Pattern. The list of tokens for each line is then passed to the given closure.
    throws:
    java.io.IOException if an error occurs
    
    Parameters:
    self - a String
    pattern - the regular expression Pattern for the delimiter
    closure - a closure
    Returns:
    the last value returned by the closure
    See Also:
    Pattern.split
    Since:
    1.6.8
  - public static Object splitEachLine(String self, Pattern pattern, @ClosureParams Closure closure)
  - public static Object splitEachLine(String self, String regex, @ClosureParams Closure closure)
    
    Strip leading spaces from every line in a CharSequence. The line with the least number of leading spaces determines the number to remove. Lines only containing whitespace are ignored when calculating the number of leading spaces to strip.
    Parameters:
    self - The CharSequence to strip the leading spaces from
    Returns:
    the stripped CharSequence
    See Also:
    stripIndent(String)
    Since:
    1.8.2
  - public static CharSequence stripIndent(CharSequence self)
    
    Strip numChar leading characters from every line in a CharSequence.
    Parameters:
    self - The CharSequence to strip the characters from
    numChars - The number of characters to strip
    Returns:
    the stripped CharSequence
    Since:
    1.8.2
  - public static CharSequence stripIndent(CharSequence self, int numChars)
  - public static String stripIndent(String self)
  - public static String stripIndent(String self, int numChars)
  - public static CharSequence stripMargin(CharSequence self)
  - public static CharSequence stripMargin(CharSequence self, char marginChar)
  - public static String stripMargin(CharSequence self, CharSequence marginChar)
  - public static String stripMargin(String self)
  - public static String stripMargin(String self, char marginChar)
  - public static String stripMargin(String self, String marginChar)
  - public static CharSequence take(CharSequence self, int num)
  - public static CharSequence takeWhile(CharSequence self, @ClosureParams Closure condition)
    
    Parse a CharSequence into a BigDecimal
    Parameters:
    self - a CharSequence
    Returns:
    a BigDecimal
    See Also:
    toBigDecimal(String)
    Since:
    1.8.2
  - public static BigDecimal toBigDecimal(CharSequence self)
    
    Parse a CharSequence into a BigInteger
    Parameters:
    self - a CharSequence
    Returns:
    a BigInteger
    See Also:
    toBigInteger(String)
    Since:
    1.8.2
  - public static BigDecimal toBigDecimal(String self)
    
    Parse a String into a BigInteger
    Parameters:
    self - a String
    Returns:
    a BigInteger
    Since:
    1.0
  - public static BigInteger toBigInteger(CharSequence self)
    
    Converts the given string into a Boolean object. If the trimmed string is "true", "y" or "1" (ignoring case) then the result is true otherwise it is false.
    Parameters:
    self - a String
    Returns:
    The Boolean value
    Since:
    1.0
  - public static BigInteger toBigInteger(String self)
  - public static Boolean toBoolean(String self)
  - public static Character toCharacter(String self)
    
    Parse a String into a Double
    Parameters:
    self - a String
    Returns:
    a Double
    Since:
    1.0
  - public static Double toDouble(CharSequence self)
    
    Parse a CharSequence into a Float
    Parameters:
    self - a CharSequence
    Returns:
    a Float
    See Also:
    toFloat(String)
    Since:
    1.8.2
  - public static Double toDouble(String self)
    
    Parse a String into a Float
    Parameters:
    self - a String
    Returns:
    a Float
    Since:
    1.0
  - public static Float toFloat(CharSequence self)
    
    Parse a CharSequence into an Integer
    Parameters:
    self - a CharSequence
    Returns:
    an Integer
    See Also:
    toInteger(String)
    Since:
    1.8.2
  - public static Float toFloat(String self)
    
    Parse a String into an Integer
    Parameters:
    self - a String
    Returns:
    an Integer
    Since:
    1.0
  - public static Integer toInteger(CharSequence self)
    
    Tokenize a CharSequence (with a whitespace as the delimiter).
    Parameters:
    self - a CharSequence
    Returns:
    a List of tokens
    See Also:
    tokenize(String)
    Since:
    1.8.2
  - public static Integer toInteger(String self)
    
    Tokenize a CharSequence based on the given character delimiter.
    Parameters:
    self - a CharSequence
    token - the delimiter
    Returns:
    a List of tokens
    See Also:
    tokenize(String, Character)
    Since:
    1.8.2
  - public static List toList(CharSequence self)
  - public static List toList(String self)
  - public static Long toLong(CharSequence self)
    
    Converts the given CharSequence into a Set of unique CharSequence of one character.
    Parameters:
    self - a CharSequence
    Returns:
    a Set of unique character CharSequence (each a 1-character CharSequence)
    See Also:
    toSet(String)
    Since:
    1.8.2
  - public static Long toLong(String self)
  - public static Set toSet(CharSequence self)
  - public static Set toSet(String self)
    
    Parse a String into a Short
    Parameters:
    self - a String
    Returns:
    a Short
    Since:
    1.5.7
  - public static Short toShort(CharSequence self)
    
    Translates a string by replacing characters from the sourceSet with characters from replacementSet.
    Parameters:
    self - the CharSequence that is to be translated
    sourceSet - the set of characters to translate from
    replacementSet - the set of replacement characters
    Returns:
    The resulting translated CharSequence
    See Also:
    tr(String, String, String)
    Since:
    1.8.2
  - public static Short toShort(String self)
  - public static List tokenize(CharSequence self)
    
    Tokenize a CharSequence based on the given CharSequence delimiter.
    Parameters:
    self - a CharSequence
    token - the delimiter
    Returns:
    a List of tokens
    See Also:
    tokenize(String, String)
    Since:
    1.8.2
  - public static List tokenize(CharSequence self, Character token)
    
    Tokenize a String (with a whitespace as the delimiter).
    Parameters:
    self - a String
    Returns:
    a List of tokens
    See Also:
    StringTokenizer.StringTokenizer
    Since:
    1.0
  - public static List tokenize(CharSequence self, CharSequence token)
  - @SuppressWarnings* @param token the delimiter public static List tokenize(String self)
  - public static List tokenize(String self, Character token)
    
    Converts the given CharSequence into a List of CharSequence of one character.
    Parameters:
    self - a CharSequence
    Returns:
    a List of characters (a 1-character CharSequence)
    See Also:
    toSet(String)
    Since:
    1.8.2
  - @SuppressWarningsfor (int i = 0; i < size; i++) { public static List tokenize(String self, String token)
    
    Converts the given String into a List of strings of one character.
    Parameters:
    self - a String
    Returns:
    a List of characters (a 1-character String)
    Since:
    1.0
  - public static CharSequence tr(CharSequence self, CharSequence sourceSet, CharSequence replacementSet)
  - public static String tr(String self, String sourceSet, String replacementSet)
    
    Replaces sequences of whitespaces with tabs using tabStops of size 8.
    Parameters:
    self - A CharSequence to unexpand
    Returns:
    The unexpanded CharSequence
    See Also:
    unexpand(String)
    Since:
    1.8.2
  - public static CharSequence unexpand(CharSequence self)
    
    Replaces sequences of whitespaces with tabs using tabStops of size 8.
    Parameters:
    self - A String to unexpand
    Returns:
    The unexpanded String
    See Also:
    unexpand(String, int)
    Since:
    1.7.3
  - public static CharSequence unexpand(CharSequence self, int tabStop)
    
    Replaces sequences of whitespaces with tabs.
    Parameters:
    self - A String to unexpand
    tabStop - The number of spaces a tab represents
    Returns:
    The unexpanded String
    Since:
    1.7.3
  - public static String unexpand(String self)
  - public static String unexpand(String self, int tabStop)
  - public static CharSequence unexpandLine(CharSequence self, int tabStop)
    
    Replaces sequences of whitespaces with tabs within a line.
    Parameters:
    self - A line to unexpand
    tabStop - The number of spaces a tab represents
    Returns:
    The unexpanded String
    Since:
    1.7.3
  - public static String unexpandLine(String self, int tabStop)

Summary:
Method

| Detail:
Method

[Java] Class StringGroovyMethods

Methods Summary

Inherited Methods Summary

Method Detail

public static boolean asBoolean(CharSequence string)

public static boolean asBoolean(Matcher matcher)

public static Object asType(CharSequence self, Class c)

@SuppressWarnings("unchecked") public static Object asType(GString self, Class c)

@SuppressWarnings("unchecked") public static Object asType(String self, Class c)

public static Pattern bitwiseNegate(CharSequence self)

public static Pattern bitwiseNegate(String self)

public static CharSequence capitalize(CharSequence self)

public static String capitalize(String self)

public static CharSequence center(CharSequence self, Number numberOfChars)

public static CharSequence center(CharSequence self, Number numberOfChars, CharSequence padding)

public static String center(String self, Number numberOfChars)

public static String center(String self, Number numberOfChars, String padding)

public static String collectReplacements(String orig, @ClosureParamsour local buffer Closure transform)

public static boolean contains(CharSequence self, CharSequence text)

public static boolean contains(String self, String text)

public static int count(CharSequence self, CharSequence text)

public static int count(String self, String text)

public static CharSequence denormalize(CharSequence self)

public static String denormalize(String self)

public static CharSequence drop(CharSequence self, int num)

public static CharSequence dropWhile(CharSequence self, @ClosureParams Closure condition)

public static Object eachLine(CharSequence self, @ClosureParams Closure closure)

public static Object eachLine(CharSequence self, int firstLine, @ClosureParams Closure closure)

public static Object eachLine(String self, @ClosureParams Closure closure)

public static Object eachLine(String self, int firstLine, @ClosureParams Closure closure)

public static String eachMatch(CharSequence self, CharSequence regex, @ClosureParamss groups Closure closure)

public static String eachMatch(CharSequence self, Pattern pattern, @ClosureParamss as groups Closure closure)

public static String eachMatch(String self, Pattern pattern, @ClosureParams Closure closure)

public static String eachMatch(String self, String regex, @ClosureParams Closure closure)

public static CharSequence expand(CharSequence self)

public static CharSequence expand(CharSequence self, int tabStop)

public static String expand(String self)

public static String expand(String self, int tabStop)

public static CharSequence expandLine(CharSequence self, int tabStop)

public static String expandLine(String self, int tabStop)

public static CharSequence find(CharSequence self, CharSequence regex)

public static CharSequence find(CharSequence self, CharSequence regex, @ClosureParams Closure closure)

public static CharSequence find(CharSequence self, Pattern pattern)

public static CharSequence find(CharSequence self, Pattern pattern, @ClosureParams Closure closure)

public static String find(String self, Pattern pattern)

public static String find(String self, Pattern pattern, @ClosureParams Closure closure)

public static String find(String self, String regex)

public static String find(String self, String regex, @ClosureParamsself, CharSequence regex) { Closure closure)

public static List findAll(CharSequence self, CharSequence regex)

public static List findAll(CharSequence self, CharSequence regex, Closure closure)

public static List findAll(CharSequence self, Pattern pattern)

public static List findAll(CharSequence self, Pattern pattern, @ClosureParams Closure closure)

public static List findAll(String self, Pattern pattern)

public static List findAll(String self, Pattern pattern, @ClosureParams Closure closure)

public static List findAll(String self, String regex)

public static List findAll(String self, String regex, @ClosureParamsllection Closure closure)

public static CharSequence getAt(CharSequence self, Collection indices)

public static CharSequence getAt(CharSequence text, EmptyRange range)

public static CharSequence getAt(CharSequence text, int index)

public static CharSequence getAt(CharSequence text, IntRange range)

public static CharSequence getAt(CharSequence text, Range range)

public static List getAt(Matcher self, Collection indices)

public static Object getAt(Matcher matcher, int idx)

public static String getAt(String self, Collection indices)

public static String getAt(String text, EmptyRange range)

public static String getAt(String text, int index)

public static String getAt(String text, IntRange range)

public static String getAt(String text, Range range)

public static char[] getChars(CharSequence self)

public static char[] getChars(String self)

public static int getCount(Matcher matcher)

public static boolean hasGroup(Matcher matcher)

public static boolean isAllWhitespace(CharSequence self)

public static boolean isAllWhitespace(String self)

public static boolean isBigDecimal(CharSequence self)

public static boolean isBigDecimal(String self)

public static boolean isBigInteger(CharSequence self)

public static boolean isBigInteger(String self)

public static boolean isCase(CharSequence caseValue, Object switchValue)

public static boolean isCase(GString caseValue, Object switchValue)