Package groovy.lang
Class GString
- java.lang.Object
-
- groovy.lang.GroovyObjectSupport
-
- groovy.lang.GString
-
- All Implemented Interfaces:
Buildable,GroovyObject,Writable,java.io.Serializable,java.lang.CharSequence,java.lang.Comparable
- Direct Known Subclasses:
GStringImpl
public abstract class GString extends GroovyObjectSupport implements java.lang.Comparable, java.lang.CharSequence, Writable, Buildable, java.io.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 java.lang.Object[]EMPTY_OBJECT_ARRAYstatic java.lang.String[]EMPTY_STRING_ARRAY
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description voidbuild(GroovyObject builder)charcharAt(int index)intcompareTo(java.lang.Object that)booleanequals(GString that)booleanequals(java.lang.Object that)byte[]getBytes()byte[]getBytes(java.lang.String charset)abstract java.lang.String[]getStrings()java.lang.ObjectgetValue(int idx)intgetValueCount()java.lang.Object[]getValues()inthashCode()java.lang.ObjectinvokeMethod(java.lang.String name, java.lang.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()java.util.regex.Patternnegate()Turns a String into a regular expression patternGStringplus(GString that)GStringplus(java.lang.String that)java.lang.CharSequencesubSequence(int start, int end)java.lang.StringtoString()java.io.WriterwriteTo(java.io.Writer out)Writes this object to the given writer.-
Methods inherited from class groovy.lang.GroovyObjectSupport
getMetaClass, getProperty, setMetaClass, setProperty
-
-
-
-
Field Detail
-
EMPTY_STRING_ARRAY
public static final java.lang.String[] EMPTY_STRING_ARRAY
-
EMPTY_OBJECT_ARRAY
public static final java.lang.Object[] EMPTY_OBJECT_ARRAY
-
EMPTY
public static final GString EMPTY
A GString containing a single empty String and no values.
-
-
Method Detail
-
getStrings
public abstract java.lang.String[] getStrings()
-
invokeMethod
public java.lang.Object invokeMethod(java.lang.String name, java.lang.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.- Specified by:
invokeMethodin interfaceGroovyObject- Overrides:
invokeMethodin classGroovyObjectSupport- 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
public java.lang.Object[] getValues()
-
plus
public GString plus(java.lang.String that)
-
getValueCount
public int getValueCount()
-
getValue
public java.lang.Object getValue(int idx)
-
toString
public java.lang.String toString()
- Specified by:
toStringin interfacejava.lang.CharSequence- Overrides:
toStringin classjava.lang.Object
-
writeTo
public java.io.Writer writeTo(java.io.Writer out) throws java.io.IOExceptionDescription 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.)
-
build
public void build(GroovyObject builder)
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
equals
public boolean equals(java.lang.Object that)
- Overrides:
equalsin classjava.lang.Object
-
equals
public boolean equals(GString that)
-
compareTo
public int compareTo(java.lang.Object that)
- Specified by:
compareToin interfacejava.lang.Comparable
-
charAt
public char charAt(int index)
- Specified by:
charAtin interfacejava.lang.CharSequence
-
length
public int length()
- Specified by:
lengthin interfacejava.lang.CharSequence
-
subSequence
public java.lang.CharSequence subSequence(int start, int end)- Specified by:
subSequencein interfacejava.lang.CharSequence
-
negate
public java.util.regex.Pattern negate()
Turns a String into a regular expression pattern- Returns:
- the regular expression pattern
-
getBytes
public byte[] getBytes()
-
getBytes
public byte[] getBytes(java.lang.String charset) throws java.io.UnsupportedEncodingException- Throws:
java.io.UnsupportedEncodingException
-
-