com.tailf.proto

Class ConfEBinary

Object

com.tailf.proto.ConfEObject

com.tailf.proto.ConfEBinary

All Implemented Interfaces:

Serializable, Cloneable

public class ConfEBinary
extends ConfEObject
implements Serializable, Cloneable

Provides a Java representation of E binaries. Anything that can be represented as a sequence of bytes can be made into an E binary.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConfEBinary(byte[] bin) Create a binary from a byte array
ConfEBinary(ConfInputStream buf) Create a binary from a stream containing a binary encoded in E external format.
ConfEBinary(Object o) Create a binary from an arbitrary Java Object.
ConfEBinary(String s)

Method Summary

Modifier and Type	Method and Description
byte[]	binaryValue() Get the byte array from a binary.
Object	clone()
void	encode(ConfOutputStream buf) Convert this binary to the equivalent E external representation.
boolean	equals(Object o) Determine if two binaries are equal.
Object	getObject() Get the java Object from the binary.
int	hashCode()
int	size() Get the size of the binary.
String	stringValue() Get the string representation of binary
String	toString() Get the string representation of this binary object.

Methods inherited from class com.tailf.proto.ConfEObject

decode

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfEBinary

public ConfEBinary(byte[] bin)

Create a binary from a byte array

Parameters:

bin - the array of bytes from which to create the binary.

ConfEBinary

public ConfEBinary(String s)

ConfEBinary

public ConfEBinary(ConfInputStream buf)
            throws ConfEDecodeException

Create a binary from a stream containing a binary encoded in E external format.

Parameters:

buf - the stream containing the encoded binary.

Throws:

ConfEDecodeException - if the buffer does not contain a valid external representation of an E binary.

ConfEBinary

public ConfEBinary(Object o)

Create a binary from an arbitrary Java Object. The object must implement java.io.Serializable or java.io.Externalizable.

Parameters:

o - the object to serialize and create this binary from.

Method Detail

binaryValue

public byte[] binaryValue()

Get the byte array from a binary.

Returns:

the byte array containing the bytes for this binary.

stringValue

public String stringValue()

Get the string representation of binary

Returns:

a string object containing the bytes for this binary.

size

public int size()

Get the size of the binary.

Returns:

the number of bytes contained in the binary.

getObject

public Object getObject()

Get the java Object from the binary. If the binary contains a serialized Java object, then this method will recreate the object.

Returns:

the java Object represented by this binary, or null if the binary does not represent a Java Object.

toString

public String toString()

Get the string representation of this binary object. A binary is printed as #Bin<N>, where N is the number of bytes contained in the object.

Specified by:

toString in class ConfEObject

Returns:

the E string representation of this binary.

encode

public void encode(ConfOutputStream buf)

Convert this binary to the equivalent E external representation.

Specified by:

encode in class ConfEObject

Parameters:

buf - an output stream to which the encoded binary should be written.

equals

public boolean equals(Object o)

Determine if two binaries are equal. Binaries are equal if they have the same length and the array of bytes is identical.

Specified by:

equals in class ConfEObject

Parameters:

o - the binary to compare to.

Returns:

true if the byte arrays contain the same bytes, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Object clone()

Overrides:

clone in class ConfEObject