com.thoughtworks.xstream.converters.extended
Class EncodedByteArrayConverter

java.lang.Object
  extended bycom.thoughtworks.xstream.converters.extended.EncodedByteArrayConverter
All Implemented Interfaces:
Converter

public class EncodedByteArrayConverter
extends java.lang.Object
implements Converter

Converts a byte array to a single encoding string (such as base64). Because this uses Sun specific classes it is not registered in XStream by default.

The following CharacterEncoder/CharacterDecoders pairs are available.

Author:
Joe Walnes

Constructor Summary
EncodedByteArrayConverter()
          Default converter uses BASE64 encoding.
EncodedByteArrayConverter(sun.misc.CharacterEncoder encoder, sun.misc.CharacterDecoder decoder)
           
 
Method Summary
 boolean canConvert(java.lang.Class type)
          Called by XStream to determine whether to use this converter instance to marshall a particular type.
 void marshal(java.lang.Object source, HierarchicalStreamWriter writer, MarshallingContext context)
          Convert an object to textual data.
 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()
Default converter uses BASE64 encoding.


EncodedByteArrayConverter

public EncodedByteArrayConverter(sun.misc.CharacterEncoder encoder,
                                 sun.misc.CharacterDecoder decoder)
Method Detail

canConvert

public boolean canConvert(java.lang.Class type)
Description copied from interface: Converter
Called by XStream to determine whether to use this converter instance to marshall a particular type.

Specified by:
canConvert in interface Converter

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.
context -
Returns:
The resulting object.


Joe Walnes, http://xstream.codehaus.org/