edu.iu.harp.resource

Class Writable

java.lang.Object

edu.iu.harp.resource.Transferable

edu.iu.harp.resource.Simple

edu.iu.harp.resource.Writable

Direct Known Subclasses:

Ack, Barrier, Join, Key, KVPartition, PartitionCount, PartitionSet, Value

public abstract class Writable
extends Simple

ByteArray class for managing writable objects.

Constructor Summary

Constructors

Constructor and Description
Writable()

Method Summary

Modifier and Type	Method and Description
abstract void	clear() Abstract method for clearing the Writable data
static <W extends Writable> W	create(java.lang.Class<W> clazz) Get a writable from ResourcePool
void	encode(java.io.DataOutput out) Encode the writable as DataOutput
static <W extends Writable> java.lang.Class<W>	forClass(java.lang.String className) Get the Class object associated with the class or interface with the given string name.
void	free() Free the writable from the ResourcePool
int	getNumEnocdeBytes() Get the number of Bytes of encoded data.
abstract int	getNumWriteBytes() Abstract method for getting the number of bytes of the Writable data
static <W extends Writable> W	newInstance(java.lang.Class<W> clazz) Get a new instance of the class
abstract void	read(java.io.DataInput in) Abstract method for reading Writable data from DataInput
void	release() Release the writable from the ResourcePool
abstract void	write(java.io.DataOutput out) Abstract method for writing Writable data to DataOutPut

Methods inherited from class java.lang.Object

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

Constructor Detail

Writable

public Writable()

Method Detail

getNumEnocdeBytes

public final int getNumEnocdeBytes()

Get the number of Bytes of encoded data.

Specified by:

getNumEnocdeBytes in class Transferable

Returns:

number of bytes

encode

public final void encode(java.io.DataOutput out)
                  throws java.io.IOException

Encode the writable as DataOutput

Specified by:

encode in class Transferable

Throws:

java.io.IOException

newInstance

public static final <W extends Writable> W newInstance(java.lang.Class<W> clazz)

Get a new instance of the class

Returns:

new instance

create

public static final <W extends Writable> W create(java.lang.Class<W> clazz)

Get a writable from ResourcePool

Returns:

a writable

forClass

public static final <W extends Writable> java.lang.Class<W> forClass(java.lang.String className)

Get the Class object associated with the class or interface with the given string name.

Parameters:

className -

Returns:

the class object

release

public final void release()

Release the writable from the ResourcePool

Specified by:

release in class Transferable

free

public final void free()

Free the writable from the ResourcePool

Specified by:

free in class Transferable

write

public abstract void write(java.io.DataOutput out)
                    throws java.io.IOException

Abstract method for writing Writable data to DataOutPut

Parameters:

out -

Throws:

java.io.IOException

read

public abstract void read(java.io.DataInput in)
                   throws java.io.IOException

Abstract method for reading Writable data from DataInput

Parameters:

in -

Throws:

java.io.IOException

clear

public abstract void clear()

Abstract method for clearing the Writable data

getNumWriteBytes

public abstract int getNumWriteBytes()

Abstract method for getting the number of bytes of the Writable data

Returns:

number of Bytes