com.crankuptheamps.client.fields

Class BookmarkField

java.lang.Object

com.crankuptheamps.client.fields.Field

com.crankuptheamps.client.fields.StringField

com.crankuptheamps.client.fields.BookmarkField

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

BookmarkRangeField

public class BookmarkField
extends StringField
implements java.lang.Cloneable

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.zip.CRC32	c
static int	MAX_BOOKMARK_LENGTH
static int	MAX_TIMESTAMP_LENGTH
static int	MIN_TIMESTAMP_LENGTH
static char	SEPARATOR_CHAR The character used to separate components of a bookmark, and to separate bookmarks from each other in a list.

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
	BookmarkField() Default constructor.
protected	BookmarkField(byte[] buffer, int position, int length) Constructor with specified buffer, position, and length.

Method Summary

Modifier and Type	Method and Description
BookmarkField	clone() Provides a way to duplicate this object and retain its specific type (and hashcode() implementation).
BookmarkField	copy() Override base class's copy() method appropriately, so we don't inadvertently mix BookmarkFields and Fields up -- they have different hashCode implementations.
boolean	equals(java.lang.Object object_) Checks if the bookmark field is equal to another object.
protected int	getConversionBufInitialSize() Overrides the base classes' initial default size for the byte and char conversion buffers used by this instance.
long	getPublisherId() Gets the publisher id for this bookmark.
long	getSequenceNumber() Gets the sequence number for this bookmark.
int	hashCode() Calculates the hash code for the bookmark field.
boolean	isBookmarkList()
boolean	isRange() Indicates whether this bookmark value appears to be a range, using only a simple check for brackets or parentheses.
boolean	isTimestamp() Indicates whether this bookmark value appears to be a timestamp.
java.util.ArrayList<BookmarkField>	parseBookmarkList() Parses the bookmark list.
static boolean	unsignedLongLess(long seqLeft_, long seqRight_) Compare two signed long values as unsigned long values; the publisherId_ and sequence are signed in java, but the actual values are unsigned, so we have to do some work to compare them.
static boolean	unsignedLongLessEqual(long seqLeft_, long seqRight_) Compare two signed long values as unsigned long values; the publisherId_ and sequence are signed in java, but the actual values are unsigned, so we have to do some work to compare them.

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, copyFrom, isNull, reset, set, set, toString

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR_CHAR

public static final char SEPARATOR_CHAR

The character used to separate components of a bookmark, and to separate bookmarks from each other in a list.

See Also:

Constant Field Values

MAX_BOOKMARK_LENGTH

public static final int MAX_BOOKMARK_LENGTH

See Also:

Constant Field Values

MAX_TIMESTAMP_LENGTH

public static final int MAX_TIMESTAMP_LENGTH

See Also:

Constant Field Values

MIN_TIMESTAMP_LENGTH

public static final int MIN_TIMESTAMP_LENGTH

See Also:

Constant Field Values

c

protected final java.util.zip.CRC32 c

Constructor Detail

BookmarkField

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

Constructor with specified buffer, position, and length.

Parameters:

buffer - The byte array containing the bookmark field.

position - The starting position of the bookmark field in the buffer.

length - The length of the bookmark field.

BookmarkField

public BookmarkField()

Default constructor.

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 42 for this class since bookmark fields are usually no larger than 40 bytes.

Overrides:

getConversionBufInitialSize in class StringField

Returns:

Returns a default size of 42.

isTimestamp

public boolean isTimestamp()

Indicates whether this bookmark value appears to be a timestamp.

Returns:

True if the value looks like an AMPS ISO-8601 timestamp.

isRange

public boolean isRange()

Indicates whether this bookmark value appears to be a range, using only a simple check for brackets or parentheses.

Returns:

True if the value looks like a range.

getPublisherId

public long getPublisherId()

Gets the publisher id for this bookmark.

Returns:

Returns the publisher id for this bookmark.

getSequenceNumber

public long getSequenceNumber()

Gets the sequence number for this bookmark.

Returns:

Returns the sequence number for this bookmark.

unsignedLongLess

public static boolean unsignedLongLess(long seqLeft_,
                                       long seqRight_)

Compare two signed long values as unsigned long values; the publisherId_ and sequence are signed in java, but the actual values are unsigned, so we have to do some work to compare them.

Parameters:

seqLeft_ - The value being compared.

seqRight_ - The value to compare to.

Returns:

true if seqLeft_ is less than seqRight_ as unsigned long values.

unsignedLongLessEqual

public static boolean unsignedLongLessEqual(long seqLeft_,
                                            long seqRight_)

Compare two signed long values as unsigned long values; the publisherId_ and sequence are signed in java, but the actual values are unsigned, so we have to do some work to compare them.

Parameters:

seqLeft_ - The value being compared.

seqRight_ - The value to compare to.

Returns:

true if seqLeft_ is less than or equal to seqRight_ as unsigned long values.

isBookmarkList

public boolean isBookmarkList()

parseBookmarkList

public java.util.ArrayList<BookmarkField> parseBookmarkList()

Parses the bookmark list.

Returns:

A list of BookmarkField

hashCode

public int hashCode()

Calculates the hash code for the bookmark field.

Overrides:

hashCode in class Field

Returns:

The hash code of the bookmark field.

clone

public BookmarkField clone()

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

Overrides:

clone in class java.lang.Object

copy

public BookmarkField copy()

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

Overrides:

copy in class Field

Returns:

The new deep copy of this instance.

equals

public boolean equals(java.lang.Object object_)

Checks if the bookmark field is equal to another object.

Overrides:

equals in class Field

Parameters:

object_ - The object to compare.

Returns:

true if the bookmark field is equal to the specified object, false otherwise.