com.thoughtworks.xstream.converters.extended

Class EncodedByteArrayConverter

java.lang.Object

com.thoughtworks.xstream.converters.extended.EncodedByteArrayConverter

All Implemented Interfaces:

Converter, ConverterMatcher, SingleValueConverter

public class EncodedByteArrayConverter
extends java.lang.Object
implements Converter, SingleValueConverter

Converts a byte array by default to a single Base64 encoding string.

Author:

Joe Walnes, Jörg Schaible

Constructor Summary

Constructors

Constructor and Description
EncodedByteArrayConverter() Constructs an EncodedByteArrayConverter.
EncodedByteArrayConverter(StringCodec stringCodec) Constructs an EncodedByteArrayConverter with a provided string codec.

Method Summary

Modifier and Type	Method and Description
boolean	canConvert(java.lang.Class type) Determines whether the converter can marshall a particular type.
java.lang.Object	fromString(java.lang.String str) Unmarshals an Object from its single value representation.
void	marshal(java.lang.Object source, HierarchicalStreamWriter writer, MarshallingContext context) Convert an object to textual data.
java.lang.String	toString(java.lang.Object obj) Marshals an Object into a single value representation.
java.lang.Object	unmarshal(HierarchicalStreamReader reader, UnmarshallingContext context) Convert textual data back into an object.

Methods inherited from class java.lang.Object

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

Constructor Detail

EncodedByteArrayConverter

public EncodedByteArrayConverter()

Constructs an EncodedByteArrayConverter. Initializes the converter with a Base64 codec.

EncodedByteArrayConverter

public EncodedByteArrayConverter(StringCodec stringCodec)

Constructs an EncodedByteArrayConverter with a provided string codec.

Parameters:

stringCodec - the codec to encode and decode the data as string

Since:

1.4.11

Method Detail

canConvert

public boolean canConvert(java.lang.Class type)

Description copied from interface: ConverterMatcher

Determines whether the converter can marshall a particular type.

Specified by:

canConvert in interface ConverterMatcher

Parameters:

type - the Class representing the object type to be converted

marshal

public void marshal(java.lang.Object source,
                    HierarchicalStreamWriter writer,
                    MarshallingContext context)

Description copied from interface: Converter

Convert an object to textual data.

Specified by:

marshal in interface Converter

Parameters:

source - The object to be marshalled.

writer - A stream to write to.

context - A context that allows nested objects to be processed by XStream.

unmarshal

public java.lang.Object unmarshal(HierarchicalStreamReader reader,
                                  UnmarshallingContext context)

Description copied from interface: Converter

Convert textual data back into an object.

Specified by:

unmarshal in interface Converter

Parameters:

reader - The stream to read the text from.

Returns:

The resulting object.

toString

public java.lang.String toString(java.lang.Object obj)

Description copied from interface: SingleValueConverter

Marshals an Object into a single value representation.

Specified by:

toString in interface SingleValueConverter

Parameters:

obj - the Object to be converted

Returns:

a String with the single value of the Object or null

fromString

public java.lang.Object fromString(java.lang.String str)

Description copied from interface: SingleValueConverter

Unmarshals an Object from its single value representation.

Specified by:

fromString in interface SingleValueConverter

Parameters:

str - the String with the single value of the Object

Returns:

the Object