com.asakusafw.runtime.value

Class StringOption

java.lang.Object

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

com.asakusafw.runtime.value.StringOption

All Implemented Interfaces:

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

public final class StringOption
extends ValueOption<StringOption>

Represents a character string value which can be null. The following snippet works well for comparing StringOption with a constant value:

class Something {
    static final StringOption TARGET = new StringOption("something");

    void something(Hoge hoge) {
        if (hoge.getValueOption().equals(TARGET)) {
            ....
        }
    }
}

Since:

0.1.0

Version:

0.9.1

Field Summary

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

nullValue

Constructor Summary

Constructors

Constructor and Description
StringOption() Creates a new instance which represents null value.
StringOption(String textOrNull) Creates a new instance which represents the specified value.

Method Summary

Modifier and Type	Method and Description
StringBuilder	appendTo(StringBuilder buffer) Appends the text in this object into the given StringBuilder.
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)
boolean	contains(String sub) Returns whether or not this text contains the given substring.
boolean	contains(StringOption sub) Returns whether or not this text contains the given substring.
void	copyFrom(StringOption optionOrNull) Deprecated.
boolean	endsWith(String suffix) Returns whether or not this text ends with the given suffix.
boolean	endsWith(StringOption suffix) Returns whether or not this text ends with the given suffix.
boolean	equals(Object obj)
org.apache.hadoop.io.Text	get() Returns the value which this object represents.
String	getAsString() 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(String other) Returns whether both this object and the specified value represents an equivalent value or not.
boolean	has(org.apache.hadoop.io.Text other) Returns whether both this object and the specified value represents an equivalent value or not.
int	hashCode()
boolean	isEmpty() Returns whether or not this text is empty.
StringOption	modify(byte[] utf8, int offset, int length) Deprecated. Application developer should not use this method directly
StringOption	modify(String newText) Deprecated. Application developer should not use this method directly
StringOption	modify(org.apache.hadoop.io.Text newText) Deprecated. Application developer should not use this method directly
String	or(String alternate) Returns the value which this object represents.
org.apache.hadoop.io.Text	or(org.apache.hadoop.io.Text alternate) Returns the value which this object represents.
void	readFields(DataInput in)
void	reset() Reset this object to an empty character string.
int	restore(byte[] bytes, int offset, int limit) Restores the contents from the slice of the byte array.
boolean	startsWith(String prefix) Returns whether or not this text starts with the given prefix.
boolean	startsWith(StringOption prefix) Returns whether or not this text starts with the given prefix.
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

StringOption

public StringOption()

Creates a new instance which represents null value.

StringOption

public StringOption(String textOrNull)

Creates a new instance which represents the specified value.

Parameters:

textOrNull - the initial value (nullable)

Method Detail

get

public org.apache.hadoop.io.Text get()

Returns the value which this object represents.

Returns:

the value which this object represents, never null

Throws:

NullPointerException - if this object represents null

getAsString

public String getAsString()

Returns the value which this object represents.

Returns:

the value which this object represents, never null

Throws:

NullPointerException - if this object represents null

See Also:

appendTo(StringBuilder)

appendTo

public StringBuilder appendTo(StringBuilder buffer)

Appends the text in this object into the given StringBuilder.

Parameters:

buffer - the destination StringBuilder

Returns:

the appended StringBuilder

Throws:

NullPointerException - if this object represents null

Since:

0.9.1

isEmpty

public boolean isEmpty()

Returns whether or not this text is empty.

Returns:

true if this text is empty, or false if it has any characters

Throws:

NullPointerException - if this object represents null

Since:

0.9.1

or

public org.apache.hadoop.io.Text or(org.apache.hadoop.io.Text 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

or

public String or(String 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

reset

public void reset()

Reset this object to an empty character string. This method makes the object non-null, an empty string even if the object just represents null.

modify

@Deprecated
public StringOption modify(org.apache.hadoop.io.Text newText)

Deprecated. Application developer should not use this method directly

Sets the value.

Parameters:

newText - the value (nullable)

Returns:

this

modify

@Deprecated
public StringOption modify(String newText)

Deprecated. Application developer should not use this method directly

Sets the value.

Parameters:

newText - the value (nullable)

Returns:

this

modify

@Deprecated
public StringOption modify(byte[] utf8,
                                       int offset,
                                       int length)

Deprecated. Application developer should not use this method directly

Sets the UTF-8 encode text contents.

Parameters:

utf8 - the UTF-8 encode byte array

offset - the offset in the byte array

length - the content length in bytes

Returns:

this

Since:

0.8.0

copyFrom

@Deprecated
public void copyFrom(StringOption optionOrNull)

Deprecated.

Description copied from class: ValueOption

Copies the value from the specified values into this.

Specified by:

copyFrom in class ValueOption<StringOption>

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

has

public boolean has(String other)

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

Parameters:

other - the target value (nullable)

Returns:

true if this object has the specified value, otherwise false

has

public boolean has(org.apache.hadoop.io.Text other)

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

Parameters:

other - the target value (nullable)

Returns:

true if this object has the specified value, otherwise false

contains

public boolean contains(String sub)

Returns whether or not this text contains the given substring.

Parameters:

sub - the substring

Returns:

true if this has the given substring or the substring is empty, otherwise false

Throws:

NullPointerException - if this or the substring is null

Since:

0.9.1

contains

public boolean contains(StringOption sub)

Returns whether or not this text contains the given substring.

Parameters:

sub - the substring

Returns:

true if this has the given substring or the substring is empty, otherwise false

Throws:

NullPointerException - if this or the substring is null

Since:

0.9.1

startsWith

public boolean startsWith(String prefix)

Returns whether or not this text starts with the given prefix.

Parameters:

prefix - the prefix

Returns:

true if this has the given prefix or the prefix is empty, otherwise false

Throws:

NullPointerException - if this or the prefix is null

Since:

0.9.1

startsWith

public boolean startsWith(StringOption prefix)

Returns whether or not this text starts with the given prefix.

Parameters:

prefix - the prefix

Returns:

true if this has the given prefix or the prefix is empty, otherwise false

Throws:

NullPointerException - if this or the prefix is null

Since:

0.9.1

endsWith

public boolean endsWith(String suffix)

Returns whether or not this text ends with the given suffix.

Parameters:

suffix - the suffix

Returns:

true if this has the given suffix or the suffix is empty, otherwise false

Throws:

NullPointerException - if this or the suffix is null

Since:

0.9.1

endsWith

public boolean endsWith(StringOption suffix)

Returns whether or not this text ends with the given suffix.

Parameters:

suffix - the suffix

Returns:

true if this has the given suffix or the suffix is empty, otherwise false

Throws:

NullPointerException - if this or the suffix is null

Since:

0.9.1

compareTo

public int compareTo(WritableRawComparable o)

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