Package groovy.lang
Class GString
java.lang.Object
groovy.lang.GroovyObjectSupport
groovy.lang.GString
- All Implemented Interfaces:
Buildable,GroovyObject,Writable,Serializable,CharSequence,Comparable
- Direct Known Subclasses:
GStringImpl
public abstract class GString extends GroovyObjectSupport implements Comparable, CharSequence, Writable, Buildable, Serializable
Represents a String which contains embedded values such as "hello there
${user} how are you?" which can be evaluated lazily. Advanced users can
iterate over the text and values to perform special processing, such as for
performing SQL operations, the values can be substituted for ? and the
actual value objects can be bound to a JDBC statement.
James Strachan: The lovely name of this class was suggested by Jules Gosnell and was such a good idea, I couldn't resist :)
- See Also:
- Serialized Form
-
Field Summary
Fields Modifier and Type Field Description static GStringEMPTYA GString containing a single empty String and no values.static Object[]EMPTY_OBJECT_ARRAYstatic String[]EMPTY_STRING_ARRAY -
Constructor Summary
-
Method Summary
Modifier and Type Method Description voidbuild(GroovyObject builder)charcharAt(int index)intcompareTo(Object that)booleanequals(GString that)booleanequals(Object that)byte[]getBytes()byte[]getBytes(String charset)abstract String[]getStrings()ObjectgetValue(int idx)intgetValueCount()Object[]getValues()inthashCode()ObjectinvokeMethod(String name, Object args)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.intlength()Patternnegate()Turns a String into a regular expression patternGStringplus(GString that)GStringplus(String that)CharSequencesubSequence(int start, int end)StringtoString()WriterwriteTo(Writer out)Writes this object to the given writer.Methods inherited from class groovy.lang.GroovyObjectSupport
getMetaClass, setMetaClassMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.CharSequence
chars, codePointsMethods inherited from interface groovy.lang.GroovyObject
getProperty, setProperty
-
Field Details
-
EMPTY_STRING_ARRAY
-
EMPTY_OBJECT_ARRAY
-
EMPTY
A GString containing a single empty String and no values.
-
-
Constructor Details
-
GString
-
GString
-
-
Method Details
-
getStrings
-
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.- Specified by:
invokeMethodin interfaceGroovyObject- Parameters:
name- the name of the method to callargs- the arguments to use for the method call- Returns:
- the result of invoking the method
-
getValues
-
plus
-
plus
-
getValueCount
public int getValueCount() -
getValue
-
toString
- Specified by:
toStringin interfaceCharSequence- Overrides:
toStringin classObject
-
writeTo
Description copied from interface:WritableWrites 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:
writeToin interfaceWritable- 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
-
hashCode
public int hashCode() -
equals
-
equals
-
compareTo
- Specified by:
compareToin interfaceComparable
-
charAt
public char charAt(int index)- Specified by:
charAtin interfaceCharSequence
-
length
public int length()- Specified by:
lengthin interfaceCharSequence
-
subSequence
- Specified by:
subSequencein interfaceCharSequence
-
negate
Turns a String into a regular expression pattern- Returns:
- the regular expression pattern
-
getBytes
public byte[] getBytes() -
getBytes
- Throws:
UnsupportedEncodingException
-