Class GStringImpl
- java.lang.Object
-
- groovy.lang.GroovyObjectSupport
-
- groovy.lang.GString
-
- org.codehaus.groovy.runtime.GStringImpl
-
- All Implemented Interfaces:
Buildable
,GroovyObject
,Writable
,Serializable
,CharSequence
,Comparable
public class GStringImpl extends GString
Default implementation of a GString used by the compiler. A GString consists of a list of values and strings which can be combined to create a new String.- See Also:
GString
, Serialized Form
-
-
Field Summary
-
Fields inherited from class groovy.lang.GString
EMPTY, EMPTY_OBJECT_ARRAY, EMPTY_STRING_ARRAY
-
-
Constructor Summary
Constructors Modifier Constructor Description GStringImpl(Object[] values, String[] strings)
Create a new GString with values and strings.protected
GStringImpl(Object[] values, String[] strings, boolean cacheable, String cachedStringLiteral, boolean frozen)
Create a new GString with values and strings.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
build(GroovyObject builder)
protected int
calcInitialCapacity()
GString
freeze()
String[]
getStrings()
Get the strings of this GString.Object[]
getValues()
GString
plus(GString that)
String
toString()
Writer
writeTo(Writer out)
Writes this object to the given writer.-
Methods inherited from class groovy.lang.GString
charAt, compareTo, equals, equals, getBytes, getBytes, getValue, getValueCount, hashCode, invokeMethod, length, negate, plus, subSequence
-
Methods inherited from class groovy.lang.GroovyObjectSupport
getMetaClass, setMetaClass
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.lang.CharSequence
chars, codePoints
-
Methods inherited from interface groovy.lang.GroovyObject
getProperty, setProperty
-
-
-
-
Constructor Detail
-
GStringImpl
public GStringImpl(Object[] values, String[] strings)
Create a new GString with values and strings.Each value is prefixed by a string, after the last value an additional String might be used, hence the following constraint is expected to hold:
strings.length == values.length || strings.length == values.length + 1
.NOTE: The lengths are not checked but using arrays with lengths which violate the above constraint could result in unpredictable behaviour.
- Parameters:
values
- the value partsstrings
- the string parts
-
GStringImpl
protected GStringImpl(Object[] values, String[] strings, boolean cacheable, String cachedStringLiteral, boolean frozen)
Create a new GString with values and strings.Each value is prefixed by a string, after the last value an additional String might be used, hence the following constraint is expected to hold:
strings.length == values.length || strings.length == values.length + 1
.NOTE: The lengths are not checked but using arrays with lengths which violate the above constraint could result in unpredictable behaviour.
- Parameters:
values
- the value partsstrings
- the string partsfrozen
- creates a GStringImpl which is not subject to mutation and hence more amenable to caching
-
-
Method Detail
-
writeTo
public Writer writeTo(Writer out) throws IOException
Description copied from interface:Writable
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.)
- Specified by:
writeTo
in interfaceWritable
- Overrides:
writeTo
in classGString
- Parameters:
out
- the Writer to which this Writable should output its data.- Returns:
- the Writer that was passed
- Throws:
IOException
- if an error occurred while outputting data to the writer
-
build
public void build(GroovyObject builder)
-
calcInitialCapacity
protected int calcInitialCapacity()
- Overrides:
calcInitialCapacity
in classGString
-
freeze
public GString freeze()
- Returns:
- returns an equivalent optimised but less mutable version of this GString
-
getStrings
public String[] getStrings()
Get the strings of this GString.This methods returns the same array as used in the constructor. Changing the values will result in changes of the GString. It is generally not recommended to do so.
- Specified by:
getStrings
in classGString
-
toString
public String toString()
- Specified by:
toString
in interfaceCharSequence
- Overrides:
toString
in classGString
-
-