eve.data

Class EncodableObject

java.lang.Object

eve.data.DataObject

eve.data.EncodableObject

All Implemented Interfaces:

DataUnit, Copyable, TextEncodable, Comparable

Direct Known Subclasses:

FontSetup, InstalledConfig, Installer.UninstallInfo, InstallerConfig, OwnedObject, OwnedProperties, RemoteAppLoader, VMOptions

public class EncodableObject
extends DataObject
implements TextEncodable

An EncodableObject encodes all its public fields, OR fields listed in an public "_fields" instance String variable (separated by commas) to a String via textEncode().

Constructor Summary

Constructors

Constructor and Description
EncodableObject()

Method Summary

Modifier and Type	Method and Description
protected TextDecoder	decode(TextDecoder td) Override this to decode the fields that you want to decode.
protected void	decoded(String from) This method is called after the base implementation of textDecode() is executed.
protected void	decoded(TextDecoder td) This is called after standard decoding is done.
TextDecoder	decodeFields(Field[] fields, TextDecoder td, String baseName) You can call this within your decode(TextDecoder te) method to encode specific fields.
TextDecoder	decodeFields(String fieldNames, TextDecoder td, String baseName) You can call this within your decode(TextDecoder te) method to encode specific fields.
protected TextEncoder	encode(TextEncoder te) Override this to encode the fields that you want to encode.
protected String	encoded(String to) This method is called after the base implementation of textEncode() is executed.
protected void	encoded(TextEncoder to) This is called after standard encoding is done.
TextEncoder	encodeFields(Field[] fields, TextEncoder te, String baseName) You can call this within your encode(TextEncoder te) method to encode specific fields.
TextEncoder	encodeFields(String fieldNames, TextEncoder te, String baseName) You can call this within your encode(TextEncoder te) method to encode specific fields.
void	textDecode(String txt) You can override this to decode a String representation of the Object as encoded by textEncode, but it is easier to override decode(TextDecoder te).
String	textEncode() You can override this to encode the object as a String, but it is easier to override encode(TextEncoder te).

Methods inherited from class eve.data.DataObject

_getFieldType, _getSetField, cache, compareTo, copied, copyFrom, equals, getCopy, getDeclaredField, getDeclaredFieldValue, getMyFieldList, getNew

Methods inherited from class java.lang.Object

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

Constructor Detail

EncodableObject

public EncodableObject()

Method Detail

textEncode

public String textEncode()

You can override this to encode the object as a String, but it is easier to override encode(TextEncoder te).

Specified by:

textEncode in interface TextEncodable

textDecode

public void textDecode(String txt)

You can override this to decode a String representation of the Object as encoded by textEncode, but it is easier to override decode(TextDecoder te).

Specified by:

textDecode in interface TextEncodable

encodeFields

public TextEncoder encodeFields(Field[] fields,
                                TextEncoder te,
                                String baseName)

You can call this within your encode(TextEncoder te) method to encode specific fields.

Parameters:

fields - An array of fields.

te - A TextEncoder object.

baseName - Either the fully qualified class and package name or the class name (without package) of the object.

Returns:

The te parameter is returned after the fields are added.

encodeFields

public TextEncoder encodeFields(String fieldNames,
                                TextEncoder te,
                                String baseName)

You can call this within your encode(TextEncoder te) method to encode specific fields.

Parameters:

fieldNames - A comma separated list of field names.

te - A TextEncoder object.

baseName - Either the fully qualified class and package name or the class name (without package) of the object.

Returns:

The te parameter is returned after the fields are added.

decodeFields

public TextDecoder decodeFields(String fieldNames,
                                TextDecoder td,
                                String baseName)

You can call this within your decode(TextDecoder te) method to encode specific fields.

Parameters:

fieldNames - A comma separated list of field names.

td - A TextDecoder object.

baseName - Either the fully qualified class and package name or the class name (without package) of the object.

Returns:

The td parameter is returned after the fields are extracted.

decodeFields

public TextDecoder decodeFields(Field[] fields,
                                TextDecoder td,
                                String baseName)

You can call this within your decode(TextDecoder te) method to encode specific fields.

Parameters:

fields - A list of fields.

td - A TextDecoder object.

baseName - Either the fully qualified class and package name or the class name (without package) of the object.

Returns:

The td parameter is returned after the fields are extracted.

encode

protected TextEncoder encode(TextEncoder te)

Override this to encode the fields that you want to encode. The LiveObject implementation of this automatically encodes all the fields for each class in the hierarchy that does not override encode(TextEncoder te); Always return the te parameter.

decode

protected TextDecoder decode(TextDecoder td)

Override this to decode the fields that you want to decode. The LiveObject implementation of this automatically decodes all the fields for each class in the hierarchy that does not override decode(TextDecoder td); Always return the td parameter.

encoded

protected void encoded(TextEncoder to)

This is called after standard encoding is done. You can add extra items to the encoder.

Parameters:

to - the TextEncoder that was used.

decoded

protected void decoded(TextDecoder td)

This is called after standard decoding is done. You can add read items from the decoder.

Parameters:

to - the TextDecoder that was used.

decoded

protected void decoded(String from)

This method is called after the base implementation of textDecode() is executed. It gives you a chance to do extra work after the fields are decoded.

Parameters:

from - The String this object was decoded from.

encoded

protected String encoded(String to)

This method is called after the base implementation of textEncode() is executed. It gives you a chance to do extra work and maybe modify the data after the fields are encoded.

Parameters:

to - the String the object has been encoded to.

Returns:

the String that should be used as the encoded text for the object. By default this method simply returns the to parameter.