org.datavec.api.writable

Class NullWritable

java.lang.Object

org.datavec.api.writable.NullWritable

All Implemented Interfaces:

Serializable, Comparable, WritableComparable, Writable

public class NullWritable
extends Object
implements WritableComparable

NullWritable. Typically only used in very limited circumstances, to signify that a value is missing. Attempts to convert the NullWritable to some other value (using toInt(), toDouble() etc) will result in an UnsupportedOperationException being thrown

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static NullWritable	INSTANCE

Constructor Summary

Constructors

Constructor and Description
NullWritable()

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object o)
boolean	equals(Object o)
WritableType	getType() Get the type of the writable.
void	readFields(DataInput in) Deserialize the fields of this object from in.
double	toDouble() Convert Writable to double.
float	toFloat() Convert Writable to float.
int	toInt() Convert Writable to int.
long	toLong() Convert Writable to long.
String	toString()
void	write(DataOutput out) Serialize the fields of this object to out.
void	writeType(DataOutput out) Write the type (a single short value) to the DataOutput.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final NullWritable INSTANCE

Constructor Detail

NullWritable

public NullWritable()

Method Detail

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable

equals

public boolean equals(Object o)

Overrides:

equals in class Object

write

public void write(DataOutput out)
           throws IOException

Description copied from interface: Writable

Serialize the fields of this object to out.

Specified by:

write in interface Writable

Parameters:

out - DataOuput to serialize this object into.

Throws:

IOException

readFields

public void readFields(DataInput in)
                throws IOException

Description copied from interface: Writable

Deserialize the fields of this object from in.

For efficiency, implementations should attempt to re-use storage in the existing object where possible.

Specified by:

readFields in interface Writable

Parameters:

in - DataInput to deseriablize this object from.

Throws:

IOException

writeType

public void writeType(DataOutput out)
               throws IOException

Description copied from interface: Writable

Write the type (a single short value) to the DataOutput. See WritableFactory for details.

Specified by:

writeType in interface Writable

Parameters:

out - DataOutput to write to

Throws:

IOException - For errors during writing

toDouble

public double toDouble()

Description copied from interface: Writable

Convert Writable to double. Whether this is supported depends on the specific writable.

Specified by:

toDouble in interface Writable

toFloat

public float toFloat()

Description copied from interface: Writable

Convert Writable to float. Whether this is supported depends on the specific writable.

Specified by:

toFloat in interface Writable

toInt

public int toInt()

Description copied from interface: Writable

Convert Writable to int. Whether this is supported depends on the specific writable.

Specified by:

toInt in interface Writable

toLong

public long toLong()

Description copied from interface: Writable

Convert Writable to long. Whether this is supported depends on the specific writable.

Specified by:

toLong in interface Writable

getType

public WritableType getType()

Description copied from interface: Writable

Get the type of the writable.

Specified by:

getType in interface Writable

Returns:

toString

public String toString()

Overrides:

toString in class Object