com.asakusafw.runtime.value

Class ByteOption

java.lang.Object

com.asakusafw.runtime.value.ValueOption<ByteOption>

com.asakusafw.runtime.value.ByteOption

All Implemented Interfaces:

WritableRawComparable, Restorable, Comparable<WritableRawComparable>, org.apache.hadoop.io.Writable, org.apache.hadoop.io.WritableComparable<WritableRawComparable>

public final class ByteOption
extends ValueOption<ByteOption>

Represents a byte value which can be null.

Field Summary

Fields inherited from class com.asakusafw.runtime.value.ValueOption

nullValue

Constructor Summary

Constructors

Constructor and Description
ByteOption() Creates a new instance which represents null value.
ByteOption(byte value) Creates a new instance which represents the specified value.

Method Summary

Modifier and Type	Method and Description
static int	compareBytes(byte[] b1, int s1, int l1, byte[] b2, int s2, int l2) Compares between the two objects in serialized form.
int	compareInBytes(byte[] b1, int o1, byte[] b2, int o2) Compares two objects in bytes.
int	compareTo(WritableRawComparable o)
void	copyFrom(ByteOption optionOrNull) Deprecated.
boolean	equals(Object obj)
byte	get() Returns the value which this object represents.
static int	getBytesLength(byte[] bytes, int offset, int length) Returns the actual number of bytes from the serialized byte array.
int	getSizeInBytes(byte[] buf, int offset) Computes and returns size in bytes.
boolean	has(int other) Returns whether both this object and the specified value represents an equivalent value or not.
int	hashCode()
ByteOption	modify(byte newValue) Deprecated. Application developer should not use this method directly
byte	or(byte alternate) Returns the value which this object represents.
void	readFields(DataInput in)
int	restore(byte[] bytes, int offset, int limit) Restores the contents from the slice of the byte array.
String	toString()
void	write(DataOutput out)

Methods inherited from class com.asakusafw.runtime.value.ValueOption

isNull, isPresent, max, min, orOption, setNull

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteOption

public ByteOption()

Creates a new instance which represents null value.

ByteOption

public ByteOption(byte value)

Creates a new instance which represents the specified value.

Parameters:

value - the initial value

Method Detail

get

public byte get()

Returns the value which this object represents.

Returns:

the value which this object represents, never null

Throws:

NullPointerException - if this object represents null

or

public byte or(byte alternate)

Returns the value which this object represents.

Parameters:

alternate - the alternative value for null

Returns:

the value which this object represents, or the alternative one if this object represents null

modify

@Deprecated
public ByteOption modify(byte newValue)

Deprecated. Application developer should not use this method directly

Sets the value.

Parameters:

newValue - the value

Returns:

this

See Also:

ValueOption.setNull()

copyFrom

@Deprecated
public void copyFrom(ByteOption optionOrNull)

Deprecated.

Description copied from class: ValueOption

Copies the value from the specified values into this.

Specified by:

copyFrom in class ValueOption<ByteOption>

Parameters:

optionOrNull - the source object, or null to make this value represent null

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(WritableRawComparable o)

has

public boolean has(int other)

Returns whether both this object and the specified value represents an equivalent value or not.

Parameters:

other - the target value

Returns:

true if this object has the specified value, otherwise false

toString

public String toString()

Overrides:

toString in class Object

write

public void write(DataOutput out)
           throws IOException

Throws:

IOException

readFields

public void readFields(DataInput in)
                throws IOException

Throws:

IOException

restore

public int restore(byte[] bytes,
                   int offset,
                   int limit)
            throws IOException

Description copied from interface: Restorable

Restores the contents from the slice of the byte array.

Parameters:

bytes - the byte array

offset - the beginning index in the byte array (inclusive)

limit - the ending index in the byte array (exclusive)

Returns:

the number of bytes to restore the contents

Throws:

IOException - if failed to restore the contents

getSizeInBytes

public int getSizeInBytes(byte[] buf,
                          int offset)
                   throws IOException

Description copied from interface: WritableRawComparable

Computes and returns size in bytes.

Parameters:

buf - bytes array

offset - bytes offset

Returns:

size in bytes

Throws:

IOException - if failed to compute size

compareInBytes

public int compareInBytes(byte[] b1,
                          int o1,
                          byte[] b2,
                          int o2)
                   throws IOException

Description copied from interface: WritableRawComparable

Compares two objects in bytes.

Parameters:

b1 - bytes representation of the first object

o1 - offset of the first object

b2 - bytes representation of the second object

o2 - offset of the second object

Returns:

the comparison result

Throws:

IOException - if failed to comparison

getBytesLength

public static int getBytesLength(byte[] bytes,
                                 int offset,
                                 int length)

Returns the actual number of bytes from the serialized byte array.

Parameters:

bytes - the target byte array

offset - the beginning index in the byte array (inclusive)

length - the limit length of the byte array

Returns:

the comparison result

compareBytes

public static int compareBytes(byte[] b1,
                               int s1,
                               int l1,
                               byte[] b2,
                               int s2,
                               int l2)

Compares between the two objects in serialized form.

Parameters:

b1 - the first byte array to be compared

s1 - the beginning index in b1

l1 - the limit byte size in b1

b2 - the second byte array to be compared

s2 - the beginning index in b2

l2 - the limit byte size in b2

Returns:

the comparison result