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.
Type Params | Return 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. |
<T> |
static T |
asType(CharSequence self, Class<T> c) |
<T> |
static T |
asType(GString self, Class<T> c) Converts the GString to a File, or delegates to the default DefaultGroovyMethods.asType |
<T> |
static T |
asType(String self, Class<T> 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) @deprecated Use the CharSequence version |
|
static String |
capitalize(CharSequence self) Convenience method to capitalize the first letter of a CharSequence (typically the first letter of a word). |
|
static String |
capitalize(String self) @deprecated Use the CharSequence version |
|
static String |
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 String |
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) @deprecated Use the CharSequence version |
|
static String |
center(String self, Number numberOfChars, String padding) @deprecated Use the CharSequence version |
|
static String |
collectReplacements(String orig, Closure<String> 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) @deprecated Use the CharSequence version |
|
static int |
count(CharSequence self, CharSequence text) Count the number of occurrences of a sub CharSequence. |
|
static int |
count(String self, String text) @deprecated Use the CharSequence version |
|
static String |
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) @deprecated Use the CharSequence version |
|
static CharSequence |
drop(CharSequence self, int num) Drops the given number of chars from the head of this CharSequence if they are available. |
|
static String |
drop(GString self, int num) A GString variant of the equivalent CharSequence method. |
|
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 String |
dropWhile(GString self, Closure condition) A GString variant of the equivalent CharSequence method. |
<T> |
static T |
eachLine(CharSequence self, Closure<T> closure) Iterates through this CharSequence line by line. |
<T> |
static T |
eachLine(CharSequence self, int firstLine, Closure<T> closure) Iterates through this CharSequence line by line. |
<T> |
static T |
eachLine(String self, Closure<T> closure) @deprecated Use the CharSequence version |
<T> |
static T |
eachLine(String self, int firstLine, Closure<T> closure) @deprecated Use the CharSequence version |
<T extends CharSequence> |
static T |
eachMatch(T self, CharSequence regex, Closure closure) Process each regex group matched substring of the given CharSequence. |
<T extends CharSequence> |
static T |
eachMatch(T self, Pattern pattern, Closure closure) Process each regex group matched substring of the given pattern. |
|
static String |
eachMatch(String self, Pattern pattern, Closure closure) Process each regex group matched substring of the given pattern. |
|
static String |
eachMatch(String self, String regex, Closure closure) Process each regex group matched substring of the given string. |
|
static boolean |
endsWithAny(CharSequence self, CharSequence... suffixes) Tests if this CharSequence ends with any specified suffixes. |
|
static String |
expand(CharSequence self) Expands all tabs into spaces with tabStops of size 8. |
|
static String |
expand(CharSequence self, int tabStop) Expands all tabs into spaces. |
|
static String |
expand(String self) @deprecated Use the CharSequence version |
|
static String |
expand(String self, int tabStop) @deprecated Use the CharSequence version |
|
static String |
expandLine(CharSequence self, int tabStop) Expands all tabs into spaces. |
|
static String |
expandLine(String self, int tabStop) @deprecated Use the CharSequence version |
|
static String |
find(CharSequence self, CharSequence regex) Finds the first occurrence of a regular expression String within a String. |
|
static String |
find(CharSequence self, CharSequence regex, Closure closure) Returns the result of calling a closure with the first occurrence of a regular expression found within a CharSequence. |
|
static String |
find(CharSequence self, Pattern pattern) Finds the first occurrence of a compiled regular expression Pattern within a String. |
|
static String |
find(CharSequence self, Pattern pattern, Closure closure) Returns the result of calling a closure with the first occurrence of a compiled regular expression found within a String. |
|
static String |
find(String self, Pattern pattern) @deprecated Use the CharSequence version |
|
static String |
find(String self, Pattern pattern, Closure closure) @deprecated Use the CharSequence version |
|
static String |
find(String self, String regex) @deprecated Use the CharSequence version |
|
static String |
find(String self, String regex, Closure closure) @deprecated Use the CharSequence version |
|
static List<String> |
findAll(CharSequence self, CharSequence regex) Returns a (possibly empty) list of all occurrences of a regular expression (provided as a CharSequence) found within a CharSequence. |
<T> |
static List<T> |
findAll(CharSequence self, CharSequence regex, Closure<T> closure) Finds all occurrences of a regular expression string within a CharSequence. |
|
static List<String> |
findAll(CharSequence self, Pattern pattern) Returns a (possibly empty) list of all occurrences of a regular expression (in Pattern format) found within a CharSequence. |
<T> |
static List<T> |
findAll(CharSequence self, Pattern pattern, Closure<T> closure) Finds all occurrences of a compiled regular expression Pattern within a CharSequence. |
|
static List<String> |
findAll(String self, Pattern pattern) @deprecated Use the CharSequence version |
<T> |
static List<T> |
findAll(String self, Pattern pattern, Closure<T> closure) @deprecated Use the CharSequence version |
|
static List<String> |
findAll(String self, String regex) @deprecated Use the CharSequence version |
<T> |
static List<T> |
findAll(String self, String regex, Closure<T> closure) @deprecated Use the CharSequence version |
|
static String |
getAt(CharSequence self, Collection indices) Select a List of characters from a CharSequence using a Collection to identify the indices to be selected. |
|
static String |
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 subscript operator for CharSequence. |
|
static String |
getAt(GString text, int index) Support the subscript operator for GString. |
|
static CharSequence |
getAt(CharSequence text, IntRange range) Support the range subscript operator for CharSequence with IntRange |
|
static String |
getAt(GString text, IntRange range) Support the range subscript operator for GString with IntRange |
|
static CharSequence |
getAt(CharSequence text, Range range) Support the range subscript operator for CharSequence |
|
static String |
getAt(GString text, Range range) Support the range subscript operator for GString |
|
static List |
getAt(Matcher self, Collection indices) Select a List of values from a Matcher using a Collection to identify the indices to be selected. |
|
static Object |
getAt(Matcher matcher, int idx) Support the subscript operator, e.g. matcher[index], for a regex Matcher. |
|
static String |
getAt(String self, Collection indices) @deprecated Use the CharSequence version |
|
static String |
getAt(String text, EmptyRange range) @deprecated Use the CharSequence version |
|
static String |
getAt(String text, int index) Support the subscript operator for String. |
|
static String |
getAt(String text, IntRange range) Support the range subscript operator for String with IntRange |
|
static String |
getAt(String text, Range range) Support the range subscript operator for String |
|
static char[] |
getChars(CharSequence self) Converts the given CharSequence into an array of characters. |
|
static char[] |
getChars(String self) @deprecated Use the CharSequence version |
|
static int |
getCount(Matcher matcher) Find the number of Strings matched to the given Matcher. |
|
static boolean |
hasGroup(Matcher matcher) Check whether a Matcher contains a group or not. |
|
static boolean |
isAllWhitespace(CharSequence self) True if a CharSequence only contains whitespace characters. |
|
static boolean |
isAllWhitespace(String self) @deprecated Use the CharSequence version |
|
static boolean |
isBigDecimal(CharSequence self) Determine if a CharSequence can be parsed as a BigDecimal. |
|
static boolean |
isBigDecimal(String self) @deprecated Use the CharSequence version |
|
static boolean |
isBigInteger(CharSequence self) Determine if a CharSequence can be parsed as a BigInteger. |
|
static boolean |
isBigInteger(String self) @deprecated Use the CharSequence version |
|
static boolean |
isCase(CharSequence caseValue, Object switchValue) 'Case' implementation for a CharSequence, which uses equals between the toString() of the caseValue and the switchValue. |
|
static boolean |
isCase(GString caseValue, Object switchValue) @deprecated Use the CharSequence version |
|
static boolean |
isCase(Pattern caseValue, Object switchValue) 'Case' implementation for the Pattern class, which allows testing a String against a number of regular expressions. |
|
static boolean |
isCase(String caseValue, Object switchValue) @deprecated Use the CharSequence version |
|
static boolean |
isDouble(CharSequence self) Determine if a CharSequence can be parsed as a Double. |
|
static boolean |
isDouble(String self) @deprecated Use the CharSequence version |
|
static boolean |
isFloat(CharSequence self) Determine if a CharSequence can be parsed as a Float. |
|
static boolean |
isFloat(String self) @deprecated Use the CharSequence version |
|
static boolean |
isInteger(CharSequence self) Determine if a CharSequence can be parsed as an Integer. |
|
static boolean |
isInteger(String self) @deprecated Use the CharSequence version |
|
static boolean |
isLong(CharSequence self) Determine if a CharSequence can be parsed as a Long. |
|
static boolean |
isLong(String self) @deprecated Use the CharSequence version |
|
static boolean |
isNumber(CharSequence self) Determine if a CharSequence can be parsed as a Number. |
|
static boolean |
isNumber(String self) @deprecated Use the CharSequence version |
|
static Iterator |
iterator(Matcher matcher) Returns an Iterator which traverses each match. |
|
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) Overloads the left shift operator to provide an easy way to append multiple objects as string representations to a String. |
|
static StringBuffer |
leftShift(StringBuffer self, Object value) Overloads the left shift operator to provide an easy way to append multiple objects as string representations to a StringBuffer. |
|
static StringBuilder |
leftShift(StringBuilder self, Object value) Overloads the left shift operator to provide syntactic sugar for appending to a StringBuilder. |
|
static boolean |
matches(CharSequence self, Pattern pattern) Tells whether or not a CharSequence matches the given compiled regular expression Pattern. |
|
static boolean |
matches(String self, Pattern pattern) @deprecated Use the CharSequence version |
|
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 String |
minus(CharSequence self, Object target) Remove a part of a CharSequence by replacing the first occurrence of target within self with '' and returns the result. |
|
static String |
minus(CharSequence self, Pattern pattern) Remove a part of a CharSequence. |
|
static String |
minus(String self, Pattern pattern) @deprecated Use the CharSequence version |
|
static String |
minus(String self, Object target) @deprecated Use the CharSequence version |
|
static String |
multiply(CharSequence self, Number factor) Repeat a CharSequence a certain number of times. |
|
static String |
multiply(String self, Number factor) @deprecated Use the CharSequence version |
|
static String |
next(CharSequence self) This method is called by the ++ operator for the class CharSequence. |
|
static String |
next(String self) @deprecated Use the CharSequence version |
|
static String |
normalize(CharSequence self) Return a String with linefeeds and carriage returns normalized to linefeeds. |
|
static String |
normalize(String self) @deprecated Use the CharSequence version |
|
static String |
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 String |
padLeft(CharSequence self, Number numberOfChars, CharSequence padding) Pad a CharSequence to a minimum length specified by numberOfChars, adding the supplied padding CharSequence as many times as needed to the left. |
|
static String |
padLeft(String self, Number numberOfChars) @deprecated Use the CharSequence version |
|
static String |
padLeft(String self, Number numberOfChars, String padding) @deprecated Use the CharSequence version |
|
static String |
padRight(CharSequence self, Number numberOfChars) Pad a CharSequence to a minimum length specified by numberOfChars by adding the space character to the right as many times as needed. |
|
static String |
padRight(CharSequence self, Number numberOfChars, CharSequence padding) Pad a CharSequence to a minimum length specified by numberOfChars, adding the supplied padding CharSequence as many times as needed to the right. |
|
static String |
padRight(String self, Number numberOfChars) @deprecated Use the CharSequence version |
|
static String |
padRight(String self, Number numberOfChars, String padding) @deprecated Use the CharSequence version |
|
static String |
plus(CharSequence left, Object value) Appends the String representation of the given operand to this CharSequence. |
|
static String |
plus(Number value, String right) Appends a String to the string representation of this number. |
|
static String |
plus(String left, Object value) @deprecated Use the CharSequence version |
|
static String |
plus(String left, CharSequence value) Appends the String representation of the given operand to this string. |
|
static String |
plus(StringBuffer left, String value) Appends a String to this StringBuffer. |
|
static String |
previous(CharSequence self) This method is called by the -- operator for the class CharSequence. |
|
static String |
previous(String self) @deprecated Use the CharSequence version |
|
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) Support the range subscript operator for StringBuffer. |
|
static List<String> |
readLines(CharSequence self) Return the lines of a CharSequence as a List of String. |
|
static List<String> |
readLines(String self) @deprecated Use the CharSequence version |
|
static String |
replaceAll(CharSequence self, CharSequence regex, CharSequence replacement) Replaces each substring of this CharSequence that matches the given regular expression with the given replacement. |
|
static String |
replaceAll(CharSequence self, CharSequence regex, Closure closure) Replaces all occurrences of a captured group by the result of calling a closure on that text. |
|
static String |
replaceAll(CharSequence self, Pattern pattern, CharSequence replacement) Replaces all substrings of a CharSequence that match the given compiled regular expression with the given replacement. |
|
static String |
replaceAll(CharSequence self, Pattern pattern, Closure closure) Replaces all occurrences of a captured group by the result of a closure call on that text. |
|
static String |
replaceAll(String self, Pattern pattern, Closure closure) @deprecated Use the CharSequence version |
|
static String |
replaceAll(String self, Pattern pattern, String replacement) @deprecated Use the CharSequence version |
|
static String |
replaceAll(String self, String regex, Closure closure) @deprecated Use the CharSequence version |
|
static String |
replaceFirst(CharSequence self, CharSequence regex, CharSequence replacement) Replaces the first substring of this CharSequence that matches the given regular expression with the given replacement. |
|
static String |
replaceFirst(CharSequence self, CharSequence regex, Closure closure) 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, CharSequence replacement) Replaces the first substring of a CharSequence that matches the given compiled regular expression with the given replacement. |
|
static String |
replaceFirst(CharSequence self, Pattern pattern, Closure closure) Replaces the first occurrence of a captured group by the result of a closure call on that text. |
|
static String |
replaceFirst(String self, Pattern pattern, Closure closure) @deprecated Use the CharSequence version |
|
static String |
replaceFirst(String self, Pattern pattern, String replacement) @deprecated Use the CharSequence version |
|
static String |
replaceFirst(String self, String regex, Closure closure) @deprecated Use the CharSequence version |
|
static String |
reverse(CharSequence self) Creates a String which is the reverse (backwards) of this CharSequence |
|
static String |
reverse(String self) @deprecated Use the CharSequence version |
|
static void |
setIndex(Matcher matcher, int idx) Set the position of the given Matcher to the given index. |
|
static int |
size(CharSequence text) Provide the standard Groovy size() method for CharSequence . |
|
static long |
size(Matcher self) Provide the standard Groovy size() method for Matcher . |
|
static int |
size(String text) Provide the standard Groovy size() method for String . |
|
static int |
size(StringBuffer buffer) Provide the standard Groovy size() method for StringBuffer . |
|
static String[] |
split(CharSequence self) Convenience method to split a CharSequence (with whitespace as delimiter). |
|
static String[] |
split(GString self) @deprecated Use the CharSequence version |
|
static String[] |
split(String self) @deprecated Use the CharSequence version |
<T> |
static T |
splitEachLine(CharSequence self, CharSequence regex, Closure<T> closure) Iterates through the given CharSequence line by line, splitting each line using the given regex delimiter. |
<T> |
static T |
splitEachLine(CharSequence self, Pattern pattern, Closure<T> closure) Iterates through the given CharSequence line by line, splitting each line using the given separator Pattern. |
<T> |
static T |
splitEachLine(String self, Pattern pattern, Closure<T> closure) @deprecated Use the CharSequence version |
<T> |
static T |
splitEachLine(String self, String regex, Closure<T> closure) @deprecated Use the CharSequence version |
|
static boolean |
startsWithAny(CharSequence self, CharSequence... prefixes) Tests if this CharSequence starts with any specified prefixes. |
|
static String |
stripIndent(CharSequence self) Strip leading spaces from every line in a CharSequence. |
|
static String |
stripIndent(CharSequence self, int numChars) Strip numChar leading characters from every line in a CharSequence. |
|
static String |
stripIndent(String self) @deprecated Use the CharSequence version |
|
static String |
stripIndent(String self, int numChars) @deprecated Use the CharSequence version |
|
static String |
stripMargin(CharSequence self) Strip leading whitespace/control characters followed by '|' from every line in a CharSequence. |
|
static String |
stripMargin(CharSequence self, char marginChar) Strip leading whitespace/control characters followed by marginChar from every line in a CharSequence. |
|
static String |
stripMargin(CharSequence self, CharSequence marginChar) Strip leading whitespace/control characters followed by marginChar from every line in a CharSequence. |
|
static String |
stripMargin(String self) @deprecated Use the CharSequence version |
|
static String |
stripMargin(String self, char marginChar) @deprecated Use the CharSequence version |
|
static String |
stripMargin(String self, String marginChar) @deprecated Use the CharSequence version |
|
static CharSequence |
take(CharSequence self, int num) Returns the first num elements from this CharSequence.
|
|
static String |
take(GString self, int num) A GString variant of the equivalent CharSequence method. |
|
static CharSequence |
takeWhile(CharSequence self, Closure condition) Returns the longest prefix of this CharSequence where each element passed to the given closure evaluates to true. |
|
static String |
takeWhile(GString self, Closure condition) A GString variant of the equivalent GString method. |
|
static BigDecimal |
toBigDecimal(CharSequence self) Parse a CharSequence into a BigDecimal |
|
static BigDecimal |
toBigDecimal(String self) @deprecated Use the CharSequence version |
|
static BigInteger |
toBigInteger(CharSequence self) Parse a CharSequence into a BigInteger |
|
static BigInteger |
toBigInteger(String self) @deprecated Use the CharSequence version |
|
static Boolean |
toBoolean(String self) Converts the given string into a Boolean object. |
|
static Character |
toCharacter(String self) Converts the given string into a Character object using the first character in the string. |
|
static Double |
toDouble(CharSequence self) Parse a CharSequence into a Double |
|
static Double |
toDouble(String self) @deprecated Use the CharSequence version |
|
static Float |
toFloat(CharSequence self) Parse a CharSequence into a Float |
|
static Float |
toFloat(String self) @deprecated Use the CharSequence version |
|
static Integer |
toInteger(CharSequence self) Parse a CharSequence into an Integer |
|
static Integer |
toInteger(String self) @deprecated Use the CharSequence version |
|
static List<String> |
toList(CharSequence self) Converts the given CharSequence into a List of Strings of one character. |
|
static List<String> |
toList(String self) @deprecated Use the CharSequence version |
|
static Long |
toLong(CharSequence self) Parse a CharSequence into a Long |
|
static Long |
toLong(String self) @deprecated Use the CharSequence version |
|
static Set<String> |
toSet(CharSequence self) Converts the given CharSequence into a Set of unique Strings of one character. |
|
static Set<String> |
toSet(String self) @deprecated Use the CharSequence version |
|
static Short |
toShort(CharSequence self) Parse a CharSequence into a Short |
|
static Short |
toShort(String self) @deprecated Use the CharSequence version |
|
static List<String> |
tokenize(CharSequence self) Tokenize a CharSequence (with a whitespace as the delimiter). |
|
static List<String> |
tokenize(CharSequence self, Character delimiter) Tokenize a CharSequence based on the given character delimiter. |
|
static List<String> |
tokenize(CharSequence self, CharSequence delimiters) Tokenize a CharSequence based on the given CharSequence. |
|
static List<String> |
tokenize(String self) @deprecated Use the CharSequence version |
|
static List<String> |
tokenize(String self, Character delimiter) @deprecated Use the CharSequence version |
|
static List<String> |
tokenize(String self, String delimiters) @deprecated Use the CharSequence version |
|
static String |
tr(CharSequence self, CharSequence sourceSet, CharSequence replacementSet) Translates a CharSequence by replacing characters from the sourceSet with characters from replacementSet. |
|
static String |
tr(String self, String sourceSet, String replacementSet) @deprecated Use the CharSequence version |
|
static String |
uncapitalize(CharSequence self) Convenience method to uncapitalize the first letter of a CharSequence (typically the first letter of a word). |
|
static String |
unexpand(CharSequence self) Replaces sequences of whitespaces with tabs using tabStops of size 8. |
|
static String |
unexpand(CharSequence self, int tabStop) Replaces sequences of whitespaces with tabs. |
|
static String |
unexpand(String self) @deprecated Use the CharSequence version |
|
static String |
unexpand(String self, int tabStop) @deprecated Use the CharSequence version |
|
static String |
unexpandLine(CharSequence self, int tabStop) Replaces sequences of whitespaces with tabs within a line. |
|
static String |
unexpandLine(String self, int tabStop) @deprecated Use the CharSequence version |
Methods inherited from class | Name |
---|---|
class DefaultGroovyMethodsSupport |
cloneSimilarCollection, cloneSimilarMap, closeQuietly, closeWithWarning, createSimilarArray, createSimilarCollection, createSimilarCollection, createSimilarCollection, createSimilarList, createSimilarMap, createSimilarOrDefaultCollection, createSimilarSet, normaliseIndex, sameType, subListBorders, subListBorders |
class Object |
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
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.
string
- the character sequenceCoerce a Matcher instance to a boolean value.
matcher
- the matcher
Provides a method to perform custom 'dynamic' type conversion
to the given class using the as
operator.
self
- a CharSequencec
- the desired classConverts the GString to a File, or delegates to the default DefaultGroovyMethods.asType
self
- a GStringc
- the desired class 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:
self
- a Stringc
- the desired classTurns a CharSequence into a regular expression Pattern
self
- a String to convert into a regular expressionConvenience method to capitalize the first letter of a CharSequence (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(' ')
self
- The CharSequence to capitalizePad 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. 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 |
self
- a CharSequence objectnumberOfChars
- the total minimum number of characters of the resultPad 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. 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+|
self
- a CharSequence objectnumberOfChars
- the total minimum number of characters of the resulting CharSequencepadding
- the characters used for padding 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'
orig
- the original Stringtransform
Closure.Provide an implementation of contains() like Collection.contains to make CharSequences more polymorphic.
self
- a CharSequencetext
- the CharSequence to look forCount the number of occurrences of a sub CharSequence.
self
- a CharSequencetext
- a sub CharSequenceReturn a CharSequence with lines (separated by LF, CR/LF, or CR) terminated by the platform specific line separator.
self
- a CharSequence objectDrops 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 ) == ''
self
- the original CharSequencenum
- the number of characters to drop from this iteratornum
ones,
or else an empty String, if this CharSequence has less than num
characters.A GString variant of the equivalent CharSequence method.
self
- the original GStringnum
- the number of characters to drop from this iteratornum
ones,
or else an empty String, if the toString() of this GString has less than num
characters.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'
self
- the original CharSequencecondition
- the closure that while continuously evaluating to true will cause us to drop elements from
the front of the original CharSequenceA GString variant of the equivalent CharSequence method.
self
- the original GStringcondition
- the closure that while continuously evaluating to true will cause us to drop elements from
the front of the original GStringIterates 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.
self
- a CharSequenceclosure
- a closureIterates 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.
self
- a CharSequencefirstLine
- the line number value used for the first line (default is 1, set to 0 to start counting from 0)closure
- a closure (arg 1 is line, optional arg 2 is line number)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.
self
- the source CharSequenceregex
- a Regex CharSequenceclosure
- a closure with one parameter or as much parameters as groupsProcess each regex group matched substring of the given pattern. 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.
self
- the source CharSequencepattern
- a regex Patternclosure
- a closure with one parameter or as much parameters as groupsProcess each regex group matched substring of the given pattern. 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.
self
- the source stringpattern
- a regex Patternclosure
- a closure with one parameter or as much parameters as groupsProcess each regex group matched substring of the given string. 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.
self
- the source stringregex
- a Regex stringclosure
- a closure with one parameter or as much parameters as groupsTests if this CharSequence ends with any specified suffixes.
suffixes
- the suffixes.true
if this CharSequence ends with any specified suffixesExpands all tabs into spaces with tabStops of size 8.
self
- A CharSequence to expandExpands all tabs into spaces. If the CharSequence has multiple lines, expand each line - restarting tab stops at the start of each line.
self
- A CharSequence to expandtabStop
- The number of spaces a tab representsExpands all tabs into spaces. Assumes the CharSequence represents a single line of text.
self
- A line to expandtabStop
- The number of spaces a tab representsFinds 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 "New York, NY".find(/\d{5}/) == nullIf it does match, we get the matching string back:
assert "New York, NY 10292-0098".find(/\d{5}/) == "10292"If we have capture groups in our expression, we still get back the full match
assert "New York, NY 10292-0098".find(/(\d{5})-?(\d{4})/) == "10292-0098"
self
- a CharSequenceregex
- the capturing regexReturns the result of calling a closure with the first occurrence of a regular expression found within a CharSequence. If the regex doesn't match, the closure will not be called and find will return null.
self
- a CharSequenceregex
- the capturing regex CharSequenceclosure
- the closure that will be passed the full match, plus each of the capturing groups (if any)Finds the first occurrence of a compiled regular expression Pattern within a String. If the pattern doesn't match, null will be returned.
For example, if the pattern doesn't match the result is null:
assert "New York, NY".find(~/\d{5}/) == nullIf it does match, we get the matching string back:
assert "New York, NY 10292-0098".find(~/\d{5}/) == "10292"If we have capture groups in our expression, the groups are ignored and we get back the full match:
assert "New York, NY 10292-0098".find(~/(\d{5})-?(\d{4})/) == "10292-0098"If you need to work with capture groups, then use the closure version of this method or use Groovy's matcher operators or use eachMatch.
self
- a CharSequencepattern
- the compiled regex PatternReturns the result of calling a closure with the first occurrence of a compiled regular expression found within a String. If the regex doesn't match, the closure will not be called and find will return null.
For example, if the pattern doesn't match, the result is null:
assert "New York, NY".find(~/\d{5}/) { match -> return "-$match-"} == nullIf it does match and we don't have any capture groups in our regex, there is a single parameter on the closure that the match gets passed to:
assert "New York, NY 10292-0098".find(~/\d{5}/) { match -> return "-$match-"} == "-10292-"If we have capture groups in our expression, our closure has one parameter for the match, followed by one for each of the capture groups:
assert "New York, NY 10292-0098".find(~/(\d{5})-?(\d{4})/) { match, zip, plusFour -> assert match == "10292-0098" assert zip == "10292" assert plusFour == "0098" return zip } == "10292"If we have capture groups in our expression, and our closure has one parameter, the closure will be passed an array with the first element corresponding to the whole match, followed by an element for each of the capture groups:
assert "New York, NY 10292-0098".find(~/(\d{5})-?(\d{4})/) { array -> assert array[0] == "10292-0098" assert array[1] == "10292" assert array[2] == "0098" return array[1] } == "10292"If a capture group is optional, and doesn't match, then the corresponding value for that capture group passed to the closure will be null as illustrated here:
assert "adsf 233-9999 adsf".find(~/(\d{3})?-?(\d{3})-(\d{4})/) { match, areaCode, exchange, stationNumber -> assert "233-9999" == match assert null == areaCode assert "233" == exchange assert "9999" == stationNumber return "$exchange$stationNumber" } == "2339999"
self
- a CharSequencepattern
- the compiled regex Patternclosure
- the closure that will be passed the full match, plus each of the capturing groups (if any)Returns a (possibly empty) list of all occurrences of a regular expression (provided as a CharSequence) found within a CharSequence.
For example, if the regex doesn't match, it returns an empty list:
assert "foo".findAll(/(\w*) Fish/) == []Any regular expression matches are returned in a list, and all regex capture groupings are ignored, only the full match is returned:
def expected = ["One Fish", "Two Fish", "Red Fish", "Blue Fish"] assert "One Fish, Two Fish, Red Fish, Blue Fish".findAll(/(\w*) Fish/) == expectedIf you need to work with capture groups, then use the closure version of this method or use Groovy's matcher operators or use eachMatch.
self
- a CharSequenceregex
- the capturing regex CharSequenceFinds all occurrences of a regular expression string within a CharSequence. 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 regex 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 "I could not, would not, with a fox.".findAll(/.ould/) { match -> "${match}n't"} == ["couldn't", "wouldn'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 orig.findAll(/(.)ocket/) { match, firstLetter -> "$firstLetter > $match" } == ["W > Wocket", "P > Pocket"]
self
- a CharSequenceregex
- the capturing regex CharSequenceclosure
- will be passed the full match plus each of the capturing groups (if any)Returns a (possibly empty) list of all occurrences of a regular expression (in Pattern format) found within a CharSequence.
For example, if the pattern doesn't match, it returns an empty list:
assert "foo".findAll(~/(\w*) Fish/) == []Any regular expression matches are returned in a list, and all regex capture groupings are ignored, only the full match is returned:
def expected = ["One Fish", "Two Fish", "Red Fish", "Blue Fish"] assert "One Fish, Two Fish, Red Fish, Blue Fish".findAll(~/(\w*) Fish/) == expected
self
- a CharSequencepattern
- the compiled regex PatternFinds all occurrences of a compiled regular expression Pattern within a CharSequence. 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 "I could not, would not, with a fox.".findAll(~/.ould/) { match -> "${match}n't"} == ["couldn't", "wouldn'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 orig.findAll(~/(.)ocket/) { match, firstLetter -> "$firstLetter > $match" } == ["W > Wocket", "P > Pocket"]
self
- a CharSequencepattern
- the compiled regex Patternclosure
- will be passed the full match plus each of the capturing groups (if any)Select a List of characters from a CharSequence using a Collection to identify the indices to be selected.
self
- a CharSequenceindices
- a Collection of indicesSupport the range subscript operator for CharSequence or StringBuffer with EmptyRange
text
- a CharSequencerange
- an EmptyRangeSupport the subscript operator for CharSequence.
text
- a CharSequenceindex
- the index of the Character to getSupport the subscript operator for GString.
text
- a GStringindex
- the index of the Character to getSupport the range subscript operator for CharSequence with IntRange
text
- a CharSequencerange
- an IntRangeSupport the range subscript operator for GString with IntRange
text
- a GStringrange
- an IntRangeSupport the range subscript operator for CharSequence
text
- a CharSequencerange
- a RangeSupport the range subscript operator for GString
text
- a GStringrange
- a RangeSelect a List of values from a Matcher using a Collection to identify the indices to be selected.
self
- a Matcherindices
- a Collection of indicesSupport the subscript operator, e.g. matcher[index], for a regex Matcher.
For an example using no group match,
def p = /ab[d|f]/ def m = "abcabdabeabf" =~ p assert 2 == m.count assert 2 == m.size() // synonym for m.getCount() assert ! m.hasGroup() assert 0 == m.groupCount() def matches = ["abd", "abf"] for (i in 0..<m.count) { assert m[i] == matches[i] }
For an example using group matches,
def p = /(?:ab([c|d|e|f]))/ def m = "abcabdabeabf" =~ p assert 4 == m.count assert m.hasGroup() assert 1 == m.groupCount() def matches = [["abc", "c"], ["abd", "d"], ["abe", "e"], ["abf", "f"]] for (i in 0..<m.count) { assert m[i] == matches[i] }
For another example using group matches,
def m = "abcabdabeabfabxyzabx" =~ /(?:ab([d|x-z]+))/ assert 3 == m.count assert m.hasGroup() assert 1 == m.groupCount() def matches = [["abd", "d"], ["abxyz", "xyz"], ["abx", "x"]] for (i in 0..<m.count) { assert m[i] == matches[i] }
matcher
- a Matcheridx
- an indexSupport the subscript operator for String.
text
- a Stringindex
- the index of the Character to getSupport the range subscript operator for String with IntRange
text
- a Stringrange
- an IntRangeSupport the range subscript operator for String
text
- a Stringrange
- a RangeConverts the given CharSequence into an array of characters.
self
- a CharSequenceFind the number of Strings matched to the given Matcher.
matcher
- a MatcherCheck whether a Matcher contains a group or not.
matcher
- a Matchertrue
if matcher contains at least one group.True if a CharSequence only contains whitespace characters.
self
- The CharSequence to check the characters inDetermine if a CharSequence can be parsed as a BigDecimal.
self
- a CharSequenceDetermine if a CharSequence can be parsed as a BigInteger.
self
- a CharSequence'Case' implementation for a CharSequence, which uses equals between the toString() of the caseValue and the switchValue. This allows CharSequence values to be used in switch statements. For example:
switch( str ) { case 'one' : // etc... }Note that this returns
true
for the case where both the
'switch' and 'case' operand is null
.
caseValue
- the case valueswitchValue
- the switch value'Case' implementation for the Pattern class, which allows testing a String against a number of regular expressions. For example:
switch( str ) { case ~/one/ : // the regex 'one' matches the value of str }Note that this returns true for the case where both the pattern and the 'switch' values are
null
.
caseValue
- the case valueswitchValue
- the switch valueDetermine if a CharSequence can be parsed as a Double.
self
- a CharSequenceDetermine if a CharSequence can be parsed as a Float.
self
- a CharSequenceDetermine if a CharSequence can be parsed as an Integer.
self
- a CharSequenceDetermine if a CharSequence can be parsed as a Long.
self
- a CharSequenceDetermine if a CharSequence can be parsed as a Number. Synonym for 'isBigDecimal()'.
self
- a CharSequenceReturns an Iterator which traverses each match.
matcher
- a Matcher objectOverloads the left shift operator to provide an easy way to append multiple objects as string representations to a CharSequence.
self
- a CharSequencevalue
- an ObjectOverloads the left shift operator to provide an easy way to append multiple objects as string representations to a String.
self
- a Stringvalue
- an ObjectOverloads the left shift operator to provide an easy way to append multiple objects as string representations to a StringBuffer.
self
- a StringBuffervalue
- a value to appendOverloads the left shift operator to provide syntactic sugar for appending to a StringBuilder.
self
- a StringBuildervalue
- an ObjectTells whether or not a CharSequence matches the given compiled regular expression Pattern.
self
- the CharSequence that is to be matchedpattern
- the regex Pattern to which the string of interest is to be matchedGiven 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()
matcher
- the MatcherRemove a part of a CharSequence by replacing the first occurrence of target within self with '' and returns the result.
self
- a CharSequencetarget
- an object representing the part to removeRemove a part of a CharSequence. This replaces the first occurrence of the pattern within self with '' and returns the result.
self
- a Stringpattern
- a Pattern representing the part to removeRepeat a CharSequence a certain number of times.
self
- a CharSequence to be repeatedfactor
- the number of times the CharSequence should be repeatedThis method is called by the ++ operator for the class CharSequence. It increments the last character in the given CharSequence. If the last character in the CharSequence is Character.MAX_VALUE a Character.MIN_VALUE will be appended. The empty CharSequence is incremented to a string consisting of the character Character.MIN_VALUE.
self
- a CharSequenceReturn a String with linefeeds and carriage returns normalized to linefeeds.
self
- a CharSequence objectPad a CharSequence to a minimum length specified by numberOfChars by adding the space character to the left as many times as needed. If the String is already the same size or bigger than the target numberOfChars, then the original String is returned. An example:
println 'Numbers:' [1, 10, 100, 1000].each{ println it.toString().padLeft(5) }will produce output like:
Numbers: 1 10 100 1000
self
- a CharSequence objectnumberOfChars
- the total minimum number of characters of the resulting CharSequencePad a CharSequence to a minimum length specified by numberOfChars, adding the supplied padding CharSequence as many times as needed to the left. If the CharSequence is already the same size or bigger than the target numberOfChars, then the toString() of the original CharSequence is returned. An example:
println 'Numbers:' [1, 10, 100, 1000].each{ println it.toString().padLeft(5, '*') } [2, 20, 200, 2000].each{ println it.toString().padLeft(5, '*_') }will produce output like:
Numbers: ****1 ***10 **100 *1000 *_*_2 *_*20 *_200 *2000
self
- a CharSequence objectnumberOfChars
- the total minimum number of characters of the resulting CharSequencepadding
- the characters used for paddingPad a CharSequence to a minimum length specified by numberOfChars by adding the space character to the right as many times as needed. If the CharSequence is already the same size or bigger than the target numberOfChars, then the toString() of the original CharSequence is returned. An example:
['A', 'BB', 'CCC', 'DDDD'].each{ println it.padRight(5) + it.size() }will produce output like:
A 1 BB 2 CCC 3 DDDD 4
self
- a CharSequence objectnumberOfChars
- the total minimum number of characters of the resulting stringPad a CharSequence to a minimum length specified by numberOfChars, adding the supplied padding CharSequence as many times as needed to the right. If the CharSequence is already the same size or bigger than the target numberOfChars, then the toString() of the original CharSequence is returned. An example:
['A', 'BB', 'CCC', 'DDDD'].each{ println it.padRight(5, '#') + it.size() }will produce output like:
A####1 BB###2 CCC##3 DDDD#4
self
- a CharSequence objectnumberOfChars
- the total minimum number of characters of the resulting CharSequencepadding
- the characters used for paddingAppends the String representation of the given operand to this CharSequence.
left
- a CharSequencevalue
- any ObjectAppends a String to the string representation of this number.
value
- a Numberright
- a StringAppends the String representation of the given operand to this string.
left
- a Stringvalue
- any CharSequenceAppends a String to this StringBuffer.
left
- a StringBuffervalue
- a StringThis method is called by the -- operator for the class CharSequence. It decrements the last character in the given CharSequence. If the last character in the CharSequence is Character.MIN_VALUE it will be deleted. The empty CharSequence can't be decremented.
self
- a CharSequenceSupport the range subscript operator for StringBuffer.
self
- a StringBufferrange
- a Rangevalue
- the object that's toString() will be insertedSupport the range subscript operator for StringBuffer. Index values are treated as characters within the buffer.
self
- a StringBufferrange
- a Rangevalue
- the object that's toString() will be insertedReturn the lines of a CharSequence as a List of String.
self
- a CharSequence objectReplaces each substring of this CharSequence that matches the given regular expression with the given replacement.
self
- a CharSequenceregex
- the capturing regexreplacement
- the string to be substituted for each matchReplaces all occurrences of a captured group by the result of calling a closure on that text.
Examples:
assert "hello world".replaceAll("(o)") { it[0].toUpperCase() } == "hellO wOrld" assert "foobar-FooBar-".replaceAll("(([fF][oO]{2})[bB]ar)", { Object[] it -> it[0].toUpperCase() }) == "FOOBAR-FOOBAR-" // Here, // it[0] is the global string of the matched group // it[1] is the first string in the matched group // it[2] is the second string in the matched group assert "foobar-FooBar-".replaceAll("(([fF][oO]{2})[bB]ar)", { x, y, z -> z.toUpperCase() }) == "FOO-FOO-" // Here, // x is the global string of the matched group // y is the first string in the matched group // z is the second string in the matched groupNote that unlike String.replaceAll(String regex, String replacement), where the replacement string treats '$' and '\' specially (for group substitution), the result of the closure is converted to a string and that value is used literally for the replacement.
self
- a CharSequenceregex
- the capturing regexclosure
- the closure to apply on each captured groupReplaces all substrings of a CharSequence that match the given compiled regular expression with the given replacement.
Note that backslashes (\) and dollar signs ($) in the replacement string may cause the results to be different than if it were being treated as a literal replacement string; see Matcher.replaceAll. Use Matcher.quoteReplacement to suppress the special meaning of these characters, if desired.
assert "foo".replaceAll('o', 'X') == 'fXX'
self
- the CharSequence that is to be matchedpattern
- the regex Pattern to which the CharSequence of interest is to be matchedreplacement
- the CharSequence to be substituted for the first matchReplaces all occurrences of a captured group by the result of a closure call on that text.
For examples,
assert "hello world".replaceAll(~"(o)") { it[0].toUpperCase() } == "hellO wOrld" assert "foobar-FooBar-".replaceAll(~"(([fF][oO]{2})[bB]ar)", { it[0].toUpperCase() }) == "FOOBAR-FOOBAR-" // Here, // it[0] is the global string of the matched group // it[1] is the first string in the matched group // it[2] is the second string in the matched group assert "foobar-FooBar-".replaceAll(~"(([fF][oO]{2})[bB]ar)", { Object[] it -> it[0].toUpperCase() }) == "FOOBAR-FOOBAR-" // Here, // it[0] is the global string of the matched group // it[1] is the first string in the matched group // it[2] is the second string in the matched group assert "foobar-FooBar-".replaceAll("(([fF][oO]{2})[bB]ar)", { x, y, z -> z.toUpperCase() }) == "FOO-FOO-" // Here, // x is the global string of the matched group // y is the first string in the matched group // z is the second string in the matched groupNote that unlike String.replaceAll(String regex, String replacement), where the replacement string treats '$' and '\' specially (for group substitution), the result of the closure is converted to a string and that value is used literally for the replacement.
self
- a CharSequencepattern
- the capturing regex Patternclosure
- the closure to apply on each captured groupReplaces the first substring of this CharSequence that matches the given regular expression with the given replacement.
self
- a CharSequenceregex
- the capturing regexreplacement
- the CharSequence to be substituted for each matchReplaces the first occurrence of a captured group by the result of a closure call on that text.
For example (with some replaceAll variants thrown in for comparison purposes),
assert "hello world".replaceFirst("(o)") { it[0].toUpperCase() } == "hellO world" // first match assert "hello world".replaceAll("(o)") { it[0].toUpperCase() } == "hellO wOrld" // all matches assert "one fish, two fish".replaceFirst(/([a-z]{3})\s([a-z]{4})/) { [one:1, two:2][it[1]] + '-' + it[2].toUpperCase() } == '1-FISH, two fish' assert "one fish, two fish".replaceAll(/([a-z]{3})\s([a-z]{4})/) { [one:1, two:2][it[1]] + '-' + it[2].toUpperCase() } == '1-FISH, 2-FISH'
self
- a CharSequenceregex
- the capturing regexclosure
- the closure to apply on the first captured groupReplaces the first substring of a CharSequence that matches the given compiled regular expression with the given replacement.
Note that backslashes (\) and dollar signs ($) in the replacement string may cause the results to be different than if it were being treated as a literal replacement string; see Matcher.replaceFirst. Use Matcher.quoteReplacement to suppress the special meaning of these characters, if desired.
assert "foo".replaceFirst('o', 'X') == 'fXo'
self
- the CharSequence that is to be matchedpattern
- the regex Pattern to which the CharSequence of interest is to be matchedreplacement
- the CharSequence to be substituted for the first matchReplaces the first occurrence of a captured group by the result of a closure call on that text.
For example (with some replaceAll variants thrown in for comparison purposes),
assert "hellO world" == "hello world".replaceFirst(~"(o)") { it[0].toUpperCase() } // first match assert "hellO wOrld" == "hello world".replaceAll(~"(o)") { it[0].toUpperCase() } // all matches assert '1-FISH, two fish' == "one fish, two fish".replaceFirst(~/([a-z]{3})\s([a-z]{4})/) { [one:1, two:2][it[1]] + '-' + it[2].toUpperCase() } assert '1-FISH, 2-FISH' == "one fish, two fish".replaceAll(~/([a-z]{3})\s([a-z]{4})/) { [one:1, two:2][it[1]] + '-' + it[2].toUpperCase() }
self
- a CharSequencepattern
- the capturing regex Patternclosure
- the closure to apply on the first captured groupCreates a String which is the reverse (backwards) of this CharSequence
self
- a CharSequenceSet the position of the given Matcher to the given index.
matcher
- a Matcheridx
- the index number Provide the standard Groovy size()
method for CharSequence
.
text
- a CharSequence Provide the standard Groovy size()
method for Matcher
.
self
- a matcher object Provide the standard Groovy size()
method for String
.
text
- a String Provide the standard Groovy size()
method for StringBuffer
.
buffer
- a StringBufferConvenience method to split a CharSequence (with whitespace as delimiter). Similar to tokenize, but returns an Array of String instead of a List.
self
- the CharSequence to splitIterates through the given CharSequence line by line, splitting each line using the given regex delimiter. The list of tokens for each line is then passed to the given closure.
self
- a CharSequenceregex
- the delimiting regular expressionclosure
- a closureIterates 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.
self
- a CharSequencepattern
- the regular expression Pattern for the delimiterclosure
- a closureTests if this CharSequence starts with any specified prefixes.
prefixes
- the prefixes.true
if this CharSequence starts with any specified prefixes.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.
assert ' A\n B\nC' == ' A\n B\n C'.stripIndent()
self
- The CharSequence to strip the leading spaces fromStrip numChar leading characters from every line in a CharSequence.
assert 'DEF\n456' == '''ABCDEF\n123456'''.stripIndent(3)
self
- The CharSequence to strip the characters fromnumChars
- The number of characters to stripStrip leading whitespace/control characters followed by '|' from every line in a CharSequence.
assert 'ABC\n123\n456' == '''ABC |123 |456'''.stripMargin()
self
- The CharSequence to strip the margin fromStrip leading whitespace/control characters followed by marginChar from every line in a CharSequence.
assert 'ABC\n123\n456' == '''ABC *123 *456'''.stripMargin('*')
self
- The CharSequence to strip the margin frommarginChar
- Any character that serves as margin delimiterStrip leading whitespace/control characters followed by marginChar from every line in a CharSequence.
self
- The CharSequence to strip the margin frommarginChar
- Any character that serves as margin delimiter Returns the first num
elements from this CharSequence.
def text = "Groovy" assert text.take( 0 ) == '' assert text.take( 2 ) == 'Gr' assert text.take( 7 ) == 'Groovy'
self
- the original CharSequencenum
- the number of chars to take from this CharSequencenum
chars,
or else the whole CharSequence if it has less then num
elements.A GString variant of the equivalent CharSequence method.
self
- the original GStringnum
- the number of chars to take from this GStringnum
chars,
or else the whole GString if it has less then num
elements.Returns the longest prefix of this CharSequence where each element passed to the given closure evaluates to true.
def text = "Groovy" assert text.takeWhile{ it < 'A' } == '' assert text.takeWhile{ it < 'Z' } == 'G' assert text.takeWhile{ it != 'v' } == 'Groo' assert text.takeWhile{ it < 'z' } == 'Groovy'
self
- the original CharSequencecondition
- the closure that must evaluate to true to continue taking elementsA GString variant of the equivalent GString method.
self
- the original GStringcondition
- the closure that must evaluate to true to continue taking elementsParse a CharSequence into a BigDecimal
self
- a CharSequenceParse a CharSequence into a BigInteger
self
- a CharSequenceConverts 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.
self
- a StringConverts the given string into a Character object using the first character in the string.
self
- a StringParse a CharSequence into a Double
self
- a CharSequenceParse a CharSequence into a Float
self
- a CharSequenceParse a CharSequence into an Integer
self
- a CharSequenceConverts the given CharSequence into a List of Strings of one character.
self
- a CharSequenceParse a CharSequence into a Long
self
- a CharSequenceConverts the given CharSequence into a Set of unique Strings of one character.
self
- a CharSequenceParse a CharSequence into a Short
self
- a CharSequenceTokenize a CharSequence (with a whitespace as the delimiter).
self
- a CharSequenceTokenize a CharSequence based on the given character delimiter. For example:
char pathSep = ':' assert "/tmp:/usr".tokenize(pathSep) == ["/tmp", "/usr"]
self
- a CharSequencedelimiter
- the delimiterTokenize a CharSequence based on the given CharSequence. Each character in the CharSequence is a separate delimiter.
self
- a CharSequencedelimiters
- the delimitersTranslates a CharSequence by replacing characters from the sourceSet with characters from replacementSet. If the first character from sourceSet appears in the CharSequence, it will be replaced with the first character from replacementSet. If the second character from sourceSet appears in the CharSequence, it will be replaced with the second character from replacementSet. and so on for all provided replacement characters.
Here is an example which converts the vowels in a word from lower to uppercase:
assert 'hello'.tr('aeiou', 'AEIOU') == 'hEllO'A character range using regex-style syntax can also be used, e.g. here is an example which converts a word from lower to uppercase:
assert 'hello'.tr('a-z', 'A-Z') == 'HELLO'Hyphens at the start or end of sourceSet or replacementSet are treated as normal hyphens and are not considered to be part of a range specification. Similarly, a hyphen immediately after an earlier range is treated as a normal hyphen. So, '-x', 'x-' have no ranges while 'a-c-e' has the range 'a-c' plus the '-' character plus the 'e' character.
Unlike the unix tr command, Groovy's tr command supports reverse ranges, e.g.:
assert 'hello'.tr('z-a', 'Z-A') == 'HELLO'If replacementSet is smaller than sourceSet, then the last character from replacementSet is used as the replacement for all remaining source characters as shown here:
assert 'Hello World!'.tr('a-z', 'A') == 'HAAAA WAAAA!'If sourceSet contains repeated characters, the last specified replacement is used as shown here:
assert 'Hello World!'.tr('lloo', '1234') == 'He224 W4r2d!'The functionality provided by tr can be achieved using regular expressions but tr provides a much more compact notation and efficient implementation for certain scenarios.
self
- the CharSequence that is to be translatedsourceSet
- the set of characters to translate fromreplacementSet
- the set of replacement charactersConvenience method to uncapitalize the first letter of a CharSequence (typically the first letter of a word). Example usage:
assert 'H'.uncapitalize() == 'h' assert 'Hello'.uncapitalize() == 'hello' assert 'Hello world'.uncapitalize() == 'hello world' assert 'Hello World'.uncapitalize() == 'hello World' assert 'hello world' == 'Hello World'.split(' ').collect{ it.uncapitalize() }.join(' ')
self
- The CharSequence to uncapitalizeReplaces sequences of whitespaces with tabs using tabStops of size 8.
self
- A CharSequence to unexpandReplaces sequences of whitespaces with tabs.
self
- A CharSequence to unexpandtabStop
- The number of spaces a tab representsReplaces sequences of whitespaces with tabs within a line.
self
- A line to unexpandtabStop
- The number of spaces a tab represents