Apache Groovy 3.0.20 · groovy.lang.GString

Modifier and Type	Field and Description
public static final GString	EMPTY A GString containing a single empty String and no values.
public static final Object[]	EMPTY_OBJECT_ARRAY
public static final String[]	EMPTY_STRING_ARRAY
private static final String	MKP
private static final long	serialVersionUID
private final Object[]	values
private static final String	YIELD

Access	Constructor and Description
public	GString(Object values)
public	GString(Object[] values)

Method Summary

Modifier and Type	Method and Description
private String[]	appendStrings(String[] strings, String[] thatStrings, int valuesLength)
private Object[]	appendValues(Object[] values, Object[] thatValues)
public void	build(final GroovyObject builder) Implements groovy.lang.Buildable.build.
private int	calcInitialCapacity()
public char	charAt(int the index of the `char` value to be returned index) Implements java.lang.CharSequence.charAt. Returns the `char` value at the specified index.
public int	compareTo(Object the object to be compared. that) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public boolean	equals(Object the reference object with which to compare. that) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public boolean	equals(GString that)
public byte[]	getBytes()
public byte[]	getBytes(String charset)
public abstract String[]	getStrings()
public Object	getValue(int idx)
public int	getValueCount()
public Object[]	getValues()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public Object	invokeMethod(String the name of the method to call name, Object the arguments to use for the method call args) Overrides default groovy.lang.GroovyObject.invokeMethod. Overloaded to implement duck typing for Strings so that any method that can't be evaluated on this object will be forwarded to the toString() object instead.
public int	length() Implements java.lang.CharSequence.length. Returns the length of this character sequence.
public Pattern	Returns: the regular expression pattern negate() Turns a String into a regular expression pattern
public GString	plus(GString that)
public GString	plus(String that)
public CharSequence	subSequence(int the start index, inclusive start, int the end index, exclusive end) Implements java.lang.CharSequence.subSequence. Returns a `CharSequence` that is a subsequence of this sequence.
public String	toString() Overrides java.lang.Object.toString. Implements java.lang.CharSequence.toString. Returns a string containing the characters in this sequence in the same order as this sequence.
public Writer	writeTo(Writer the Writer to which this Writable should output its data. out) Implements groovy.lang.Writable.writeTo. Writes this object to the given writer.

Inherited from groovy.lang.GroovyObjectSupport:: getMetaClass setMetaClass

EMPTY	back to summary
public static final GString EMPTY A GString containing a single empty String and no values.

EMPTY_OBJECT_ARRAY	back to summary
public static final Object[] EMPTY_OBJECT_ARRAY

EMPTY_STRING_ARRAY	back to summary
public static final String[] EMPTY_STRING_ARRAY

MKP	back to summary
private static final String MKP

serialVersionUID	back to summary
private static final long serialVersionUID

values	back to summary
private final Object[] values

YIELD	back to summary
private static final String YIELD

GString	back to summary
public GString(Object values)

GString	back to summary
public GString(Object[] values)

Method Detail

appendStrings	back to summary
private String[] appendStrings(String[] strings, String[] thatStrings, int valuesLength)

appendValues	back to summary
private Object[] appendValues(Object[] values, Object[] thatValues)

build	back to summary
public void build(final GroovyObject builder) Implements groovy.lang.Buildable.build. Annotations @Override

build

back to summary

public void build(final GroovyObject builder)

Implements groovy.lang.Buildable.build.

Annotations

@Override

calcInitialCapacity	back to summary
private int calcInitialCapacity()

charAt back to summary

charAt	back to summary
public char charAt(int index) Implements java.lang.CharSequence.charAt. Doc from java.lang.CharSequence.charAt. Returns the `char` value at the specified index. An index ranges from zero to `length() - 1`. The first `char` value of the sequence is at index zero, the next at index one, and so on, as for array indexing. If the `char` value specified by the index is a surrogate, the surrogate value is returned. Parameters index:int the index of the `char` value to be returned Returns:char the specified `char` value Annotations @Override

public char charAt(int index)

Implements java.lang.CharSequence.charAt.

Doc from java.lang.CharSequence.charAt.

Returns the char value at the specified index. An index ranges from zero to length() - 1. The first char value of the sequence is at index zero, the next at index one, and so on, as for array indexing.

If the char value specified by the index is a surrogate, the surrogate value is returned.

Parameters

index:int: the index of the char value to be returned

Returns:char

the specified char value

Annotations

@Override

compareTo back to summary

compareTo	back to summary
public int compareTo(Object that) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters that:Object the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public int compareTo(Object that)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

that:Object: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object that) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters that:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object that)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

that:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

equals	back to summary
public boolean equals(GString that)

getBytes	back to summary
public byte[] getBytes()

getBytes	back to summary
public byte[] getBytes(String charset) throws UnsupportedEncodingException

getStrings	back to summary
public abstract String[] getStrings()

getValue	back to summary
public Object getValue(int idx)

getValueCount	back to summary
public int getValueCount()

getValues	back to summary
public Object[] getValues()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

invokeMethod	back to summary
public Object invokeMethod(String name, Object args) Overrides default groovy.lang.GroovyObject.invokeMethod. Overloaded to implement duck typing for Strings so that any method that can't be evaluated on this object will be forwarded to the toString() object instead. Parameters name:String Doc from groovy.lang.GroovyObject.invokeMethod. the name of the method to call args:Object Doc from groovy.lang.GroovyObject.invokeMethod. the arguments to use for the method call Returns:Object Doc from groovy.lang.GroovyObject.invokeMethod. the result of invoking the method Annotations @Override

invokeMethod

back to summary

public Object invokeMethod(String name, Object args)

Overrides default groovy.lang.GroovyObject.invokeMethod.

Overloaded to implement duck typing for Strings so that any method that can't be evaluated on this object will be forwarded to the toString() object instead.

Parameters

name:String

Doc from groovy.lang.GroovyObject.invokeMethod.

the name of the method to call

args:Object

Doc from groovy.lang.GroovyObject.invokeMethod.

the arguments to use for the method call

Returns:Object

Doc from groovy.lang.GroovyObject.invokeMethod.

the result of invoking the method

Annotations

@Override

length back to summary

length	back to summary
public int length() Implements java.lang.CharSequence.length. Doc from java.lang.CharSequence.length. Returns the length of this character sequence. The length is the number of 16-bit `char`s in the sequence. Returns:int the number of `char`s in this sequence Annotations @Override

public int length()

Implements java.lang.CharSequence.length.

Doc from java.lang.CharSequence.length.

Returns the length of this character sequence. The length is the number of 16-bit chars in the sequence.

Returns:int

the number of chars in this sequence

Annotations

@Override

negate	back to summary
public Pattern negate() Turns a String into a regular expression pattern Returns:Pattern the regular expression pattern

negate

back to summary

public Pattern negate()

Turns a String into a regular expression pattern

Returns:Pattern: the regular expression pattern

plus	back to summary
public GString plus(GString that)

plus	back to summary
public GString plus(String that)

subSequence back to summary

subSequence	back to summary
public CharSequence subSequence(int start, int end) Implements java.lang.CharSequence.subSequence. Doc from java.lang.CharSequence.subSequence. Returns a `CharSequence` that is a subsequence of this sequence. The subsequence starts with the `char` value at the specified index and ends with the `char` value at index `end - 1`. The length (in `char`s) of the returned sequence is `end - start`, so if `start == end` then an empty sequence is returned. Parameters start:int the start index, inclusive end:int the end index, exclusive Returns:CharSequence the specified subsequence Annotations @Override

public CharSequence subSequence(int start, int end)

Implements java.lang.CharSequence.subSequence.

Doc from java.lang.CharSequence.subSequence.

Returns a CharSequence that is a subsequence of this sequence. The subsequence starts with the char value at the specified index and ends with the char value at index end - 1. The length (in chars) of the returned sequence is end - start, so if start == end then an empty sequence is returned.

Parameters

start:int: the start index, inclusive
end:int: the end index, exclusive

Returns:CharSequence

the specified subsequence

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Implements java.lang.CharSequence.toString. Doc from java.lang.CharSequence.toString. Returns a string containing the characters in this sequence in the same order as this sequence. The length of the string will be the length of this sequence. Returns:String a string consisting of exactly this sequence of characters Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Implements java.lang.CharSequence.toString.

Doc from java.lang.CharSequence.toString.

Returns a string containing the characters in this sequence in the same order as this sequence. The length of the string will be the length of this sequence.

Returns:String

a string consisting of exactly this sequence of characters

Annotations

@Override

writeTo	back to summary
public Writer writeTo(Writer out) throws IOException Implements groovy.lang.Writable.writeTo. Doc from groovy.lang.Writable.writeTo. Writes this object to the given writer. This is used to defer content creation until the point when it is streamed to the output destination. Oftentimes, content will be defined but not necessarily created (as is may be the case with a Closure definition.) In that case, the output is then 'deferred' to the point when it is serialized to the writer. This class may be used whenever an object should be responsible for creating its own textual representation, but creating the entire output as a single String would be inefficient (such as outputting a multi-gigabyte XML document.) Parameters out:Writer the Writer to which this Writable should output its data. Returns:Writer the Writer that was passed Annotations @Override Exceptions IOException: if an error occurred while outputting data to the writer

writeTo

back to summary

public Writer writeTo(Writer out) throws IOException

Implements groovy.lang.Writable.writeTo.

Doc from groovy.lang.Writable.writeTo.

Writes this object to the given writer.

This is used to defer content creation until the point when it is streamed to the output destination. Oftentimes, content will be defined but not necessarily created (as is may be the case with a Closure definition.) In that case, the output is then 'deferred' to the point when it is serialized to the writer. This class may be used whenever an object should be responsible for creating its own textual representation, but creating the entire output as a single String would be inefficient (such as outputting a multi-gigabyte XML document.)

Parameters

out:Writer: the Writer to which this Writable should output its data.

Returns:Writer

the Writer that was passed

Annotations

@Override

Exceptions

IOException:: if an error occurred while outputting data to the writer

public abstract Class GString

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail