com.crankuptheamps.client.fields

Class BookmarkRangeField

java.lang.Object

com.crankuptheamps.client.fields.Field

com.crankuptheamps.client.fields.StringField

com.crankuptheamps.client.fields.BookmarkField

com.crankuptheamps.client.fields.BookmarkRangeField

All Implemented Interfaces:

java.lang.Cloneable

public class BookmarkRangeField
extends BookmarkField

Field data for a Message consisting of the bookmark. This is the AMPS Bookmark for the Message.

Field Summary

Fields inherited from class com.crankuptheamps.client.fields.BookmarkField

c, MAX_BOOKMARK_LENGTH, MAX_TIMESTAMP_LENGTH, MIN_TIMESTAMP_LENGTH, SEPARATOR_CHAR

Fields inherited from class com.crankuptheamps.client.fields.StringField

LATIN1, LATIN1_ZERO

Fields inherited from class com.crankuptheamps.client.fields.Field

buffer, length, position

Constructor Summary

Constructors

Modifier	Constructor and Description
	BookmarkRangeField() Constructs a new empty BookmarkRangeField.
protected	BookmarkRangeField(byte[] buffer, int position, int length) Constructs a new BookmarkRangeField with the provided buffer, position, and length.

Method Summary

Modifier and Type	Method and Description
BookmarkRangeField	clone() Provides a way to duplicate this object and retain its specific type (and hashcode() implementation).
BookmarkRangeField	copy() Override base class's copy() method appropriately, so we don't inadvertently mix BookmarkRangeFields and Fields up -- they have different hashCode implementations.
void	copyFrom(Field f) Provides a way to make this object a duplicate of f if f represents a valid bookmark range.
boolean	equals(java.lang.Object object_) Indicates whether some other object is "equal to" this one.
protected int	getConversionBufInitialSize() Overrides the base classes' initial default size for the byte and char conversion buffers used by this instance.
BookmarkField	getEnd() Gets the end bookmark of the range.
BookmarkField	getStart() Gets the start bookmark of the range.
int	hashCode() Computes the hash code for this BookmarkRangeField.
boolean	isEndExclusive() Checks if the bookmark range ends exclusively (exclusive range).
boolean	isEndInclusive() Checks if the bookmark range ends inclusively (inclusive range).
boolean	isStartExclusive() Checks if the bookmark range starts exclusively (exclusive range).
boolean	isStartInclusive() Checks if the bookmark range starts inclusively (inclusive range).
boolean	isValid() Checks if the bookmark range is valid.
void	replaceStart(Field start_) Replaces the start bookmark of the range.
void	replaceStart(Field start_, boolean makeExclusive) Replaces the start bookmark of the range.

Methods inherited from class com.crankuptheamps.client.fields.BookmarkField

getPublisherId, getSequenceNumber, isBookmarkList, isRange, isTimestamp, parseBookmarkList, unsignedLongLess, unsignedLongLessEqual

Methods inherited from class com.crankuptheamps.client.fields.StringField

getValue, getValue, getValue, setValue, setValue, setValue

Methods inherited from class com.crankuptheamps.client.fields.Field

byteAt, isNull, reset, set, set, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BookmarkRangeField

protected BookmarkRangeField(byte[] buffer,
                             int position,
                             int length)

Constructs a new BookmarkRangeField with the provided buffer, position, and length.

Parameters:

buffer - The buffer containing the bookmark range.

position - The starting position of the bookmark range within the buffer

length - The length of the bookmark range.

BookmarkRangeField

public BookmarkRangeField()

Constructs a new empty BookmarkRangeField.

Method Detail

getConversionBufInitialSize

protected int getConversionBufInitialSize()

Overrides the base classes' initial default size for the byte and char conversion buffers used by this instance. Defaults to 128 which is sufficient for 2 bookmarks and associated chars.

Overrides:

getConversionBufInitialSize in class BookmarkField

Returns:

Returns a default size of 128.

copyFrom

public void copyFrom(Field f)

Provides a way to make this object a duplicate of f if f represents a valid bookmark range.

Overrides:

copyFrom in class Field

Parameters:

f - The Field to copy from.

isValid

public boolean isValid()

Checks if the bookmark range is valid.

Returns:

True if the bookmark range is valid, false otherwise.

getStart

public BookmarkField getStart()

Gets the start bookmark of the range.

Returns:

The start bookmark of the range.

getEnd

public BookmarkField getEnd()

Gets the end bookmark of the range.

Returns:

The end bookmark of the range.

isStartInclusive

public boolean isStartInclusive()

Checks if the bookmark range starts inclusively (inclusive range).

Returns:

True if the range starts inclusively, false otherwise.

isEndInclusive

public boolean isEndInclusive()

Checks if the bookmark range ends inclusively (inclusive range).

Returns:

True if the end of the buffer is inclusive, otherwise false.

isStartExclusive

public boolean isStartExclusive()

Checks if the bookmark range starts exclusively (exclusive range).

Returns:

True if the range starts exclusively, false otherwise.

isEndExclusive

public boolean isEndExclusive()

Checks if the bookmark range ends exclusively (exclusive range).

Returns:

True if the range ends exclusively, false otherwise.

replaceStart

public void replaceStart(Field start_)

Replaces the start bookmark of the range.

Parameters:

start_ - The new start bookmark.

replaceStart

public void replaceStart(Field start_,
                         boolean makeExclusive)

Replaces the start bookmark of the range.

Parameters:

start_ - The new start bookmark.

makeExclusive - Indicates whether the new start should be exclusive.

clone

public BookmarkRangeField clone()

Provides a way to duplicate this object and retain its specific type (and hashcode() implementation).

Overrides:

clone in class BookmarkField

Returns:

A new instance of BookmarkRangeField with the same data.

copy

public BookmarkRangeField copy()

Override base class's copy() method appropriately, so we don't inadvertently mix BookmarkRangeFields and Fields up -- they have different hashCode implementations.

Overrides:

copy in class BookmarkField

Returns:

The new deep copy of this instance.

hashCode

public int hashCode()

Computes the hash code for this BookmarkRangeField.

Overrides:

hashCode in class BookmarkField

Returns:

The hash code value for this BookmarkRangeField.

equals

public boolean equals(java.lang.Object object_)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class BookmarkField

Parameters:

object_ - The object to compare with.

Returns:

True if this BookmarkRangeField is the same as the object argument; false otherwise.