org.apache.juneau.utils

Class StringObject

java.lang.Object

org.apache.juneau.utils.StringObject

All Implemented Interfaces:

CharSequence, Writable

public class StringObject
extends Object
implements CharSequence, Writable

A serializer/object pair used for delayed object serialization.

Useful in certain conditions such as logging when you don't want to needlessly serialize objects.

Instances of this method are created by the WriterSerializer.toStringObject(Object) method.

Example:

// The POJO will not be serialized unless DEBUG is enabled. logger.log(DEBUG, "Object contents are: {0}", JsonSerializer.DEFAULT.toObjectString(myPojo));

Constructor Summary

Constructors

Constructor and Description
StringObject(Object o) Constructor with default serializer SimpleJsonSerializer.DEFAULT
StringObject(WriterSerializer s, Object o) Constructor.

Method Summary

Modifier and Type	Method and Description
char	charAt(int index)
MediaType	getMediaType() Returns the serialized media type for this resource (e.g.
int	length()
CharSequence	subSequence(int start, int end)
String	toString()
Writer	writeTo(Writer w) Serialize this object to the specified writer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Constructor Detail

StringObject

public StringObject(WriterSerializer s,
                    Object o)

Constructor.

Parameters:

s - The serializer to use to serialize the object.

o - The object to be serialized.

StringObject

public StringObject(Object o)

Constructor with default serializer SimpleJsonSerializer.DEFAULT

Parameters:

o - The object to be serialized.

Method Detail

toString

public String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

length

public int length()

Specified by:

length in interface CharSequence

charAt

public char charAt(int index)

Specified by:

charAt in interface CharSequence

subSequence

public CharSequence subSequence(int start,
                                int end)

Specified by:

subSequence in interface CharSequence

writeTo

public Writer writeTo(Writer w)
               throws IOException

Description copied from interface: Writable

Serialize this object to the specified writer.

Specified by:

writeTo in interface Writable

Parameters:

w - The writer to write to.

Returns:

The same writer passed in.

Throws:

IOException - Thrown by underlying stream.

getMediaType

public MediaType getMediaType()

Description copied from interface: Writable

Returns the serialized media type for this resource (e.g. "text/html")

Specified by:

getMediaType in interface Writable

Returns:

The media type, or null if the media type is not known.