BookmarkField (AMPS Java Client (5.3.2.1.6d15937f.540279))

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()

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

Constructors
Modifier	Constructor and Description
	`BookmarkField()`
`protected`	`BookmarkField(byte[] buffer, int position, int length)`

Method Summary

All Methods Instance Methods Concrete Methods
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()` Constructs a new Field and sets its value to a deep copy of this instance.
`boolean`	`equals(java.lang.Object object_)` Default implementation for `Object.equals(java.lang.Object)` for a Field.
`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()` Default implementation of `Object.hashCode()` for a Field.
`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.

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)
```
  - BookmarkField
```
public BookmarkField()
```
- 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.
  - hashCode
```
public int hashCode()
```
    Description copied from class: Field
    
    Default implementation of Object.hashCode() for a Field.
    
    Overrides:
    
    hashCode in class 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()
```
    Description copied from class: Field
    
    Constructs a new Field and sets its value to a deep copy of this instance.
    
    Overrides:
    
    copy in class Field
    
    Returns:
    
    The new deep copy of this instance.
  - equals
```
public boolean equals(java.lang.Object object_)
```
    Description copied from class: Field
    
    Default implementation for Object.equals(java.lang.Object) for a Field. For two Fields to be considered equal, their values must have the same length and all bytes in the value must be equal.
    
    Overrides:
    
    equals in class Field
    
    Parameters:
    
    object_ - The object to compare this with.

Class BookmarkField

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

SEPARATOR_CHAR

MAX_BOOKMARK_LENGTH

MAX_TIMESTAMP_LENGTH

MIN_TIMESTAMP_LENGTH

c

Constructor Detail

BookmarkField

BookmarkField

Method Detail

getConversionBufInitialSize

isTimestamp

isRange

getPublisherId

getSequenceNumber

hashCode

clone

copy

equals