BookmarkRingBuffer (AMPS Java Client (5.3.4.0.14fbce6f.256885))

java.lang.Object
- com.crankuptheamps.client.BookmarkRingBuffer

```
public class BookmarkRingBuffer
extends java.lang.Object
```
A ring buffer of bookmarks and activation status Used by all of the bookmark stores to track state of bookmarks we need to hold on to, either because they're active or because they're after an active one.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BookmarkRingBuffer.Entry
Represents a single entry in an array of bookmarks

Nested Classes
Modifier and Type	Class and Description
`static class`	`BookmarkRingBuffer.Entry` Represents a single entry in an array of bookmarks

Field Summary

Fields
Modifier and Type Field and Description

static int UNSET_INDEX
Constant representing an unset index value.

Fields
Modifier and Type	Field and Description
`static int`	`UNSET_INDEX` Constant representing an unset index value.

Constructor Summary

Constructors
Constructor and Description

BookmarkRingBuffer()
Initializes the underlying array, and sets the "last discarded" value to something reasonable.

Constructors
Constructor and Description
`BookmarkRingBuffer()` Initializes the underlying array, and sets the "last discarded" value to something reasonable.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`capacity()` Size of underlying array.
`void`	`checkResize()` Called to check if resizing of the BookmarkRingBuffer is possible.
`boolean`	`discard(long index)` Discards an entry by index.
`BookmarkRingBuffer.Entry`	`find(BookmarkField field)` Finds an entry in the bookmark ring buffer with a specified bookmark field.
`BookmarkRingBuffer.Entry`	`getByIndex(long index)` Retrieves an Entry given an index.
`long`	`getEndIndex()` Returns the index value one greater than the last valid Entry in self.
`BookmarkField`	`getLastDiscarded()` Returns the "last discarded" bookmark.
`java.util.ArrayList<BookmarkRingBuffer.Entry>`	`getRecoveryEntries()` Deprecated.
`void`	`getRecoveryEntries(java.util.ArrayList<BookmarkRingBuffer.Entry> entryList_)` Gets a list of recovery entries from the BookmarkRingBuffer.
`long`	`getStartIndex()` Returns the index value associated with the first valid Entry in self.
`boolean`	`isEmpty()` Returns if the buffer is currently empty.
`long`	`log(BookmarkField bookmark)` Logs the bookmark by allocating an Entry, setting the Entry to active, copying the bookmark value to that entry, and returning the index of that entry.
`void`	`persisted(BookmarkField bookmark)` Deprecated.
`void`	`persisted(long bookmark)` Deprecated.
`long`	`relog(long oldIndex, BookmarkField bookmark)` Deprecated.
`void`	`reset()` Resets this bookmark ring buffer for reuse by clearing out its state.
`long`	`setRecovery()` Deprecated.
`void`	`setResizeHandler(BookmarkStoreResizeHandler handler, BookmarkStore store)` Call this when you want to set a resize handler that is invoked when a store needs a resize.
`void`	`setSubId(Field sub)` Sets the Subscription Identifier for the bookmark.
`java.lang.String`	`toString()` Returns a debugging string representing ring buffer state.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - UNSET_INDEX
```
public static final int UNSET_INDEX
```
    Constant representing an unset index value.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BookmarkRingBuffer
```
public BookmarkRingBuffer()
```
    Initializes the underlying array, and sets the "last discarded" value to something reasonable.
- Method Detail
  - reset
```
public void reset()
```
    Resets this bookmark ring buffer for reuse by clearing out its state.
  - capacity
```
public int capacity()
```
    Size of underlying array.
    
    Returns:
    
    Current capacity of self.
  - getByIndex
```
public BookmarkRingBuffer.Entry getByIndex(long index)
```
    Retrieves an Entry given an index.
    
    Parameters:
    
    index - An index returned by .getIndex(), getStartIndex(), getEndIndex(), log, etc.
    
    Returns:
    
    The entry at that index, or null if not found.
  - getLastDiscarded
```
public BookmarkField getLastDiscarded()
```
    Returns the "last discarded" bookmark. This may be a newer bookmark than the one you last passed to discard(), if you're discarding out of order.
    
    Returns:
    
    The last Bookmark discarded.
  - isEmpty
```
public boolean isEmpty()
```
    Returns if the buffer is currently empty.
    
    Returns:
    
    True if self is empty, false otherwise.
  - getStartIndex
```
public long getStartIndex()
```
    Returns the index value associated with the first valid Entry in self.
    
    Returns:
    
    Index of first valid Entry.
  - getEndIndex
```
public long getEndIndex()
```
    Returns the index value one greater than the last valid Entry in self.
    
    Returns:
    
    Index 1 greater than last valid entry.
  - log
```
public long log(BookmarkField bookmark)
```
    Logs the bookmark by allocating an Entry, setting the Entry to active, copying the bookmark value to that entry, and returning the index of that entry.
    
    Parameters:
    
    bookmark - The Bookmark to log.
    
    Returns:
    
    The index of the new Entry.
  - discard
```
public boolean discard(long index)
```
    Discards an entry by index. If the discard is completed, lastDiscarded will change, otherwise the discard is cached in the entry, and the getLastDiscarded() value is unchanged.
    
    Parameters:
    
    index - The index of the Entry to be discarded.
    
    Returns:
    
    True if this caused lastDiscarded to change.
  - find
```
public BookmarkRingBuffer.Entry find(BookmarkField field)
```
    Finds an entry in the bookmark ring buffer with a specified bookmark field.
    
    Parameters:
    
    field - The bookmark that you are searching for.
    
    Returns:
    
    The entry with the specified bookmark field if found, or null if the Entry was not found.
  - persisted
```
@Deprecated
public void persisted(BookmarkField bookmark)
```
    Deprecated.
    
    WARNING: @deprecated. Do Not Use. Old Doc: Mark all records up to the and including the provided bookmark as safe for discard and discard all appropriate bookmarks. Applies to server versions 3.8x.
    
    Parameters:
    
    bookmark - The latest bookmark that can be safely disposed.
  - persisted
```
@Deprecated
public void persisted(long bookmark)
```
    Deprecated.
    
    WARNING: @deprecated. Do Not Use. Old Doc: Called internally by the Client to record the last persisted message in the transaction log of the connected AMPS server.
    
    Parameters:
    
    bookmark - The bookmark containing the message.
  - checkResize
```
public void checkResize()
```
    Called to check if resizing of the BookmarkRingBuffer is possible.
  - setResizeHandler
```
public void setResizeHandler(BookmarkStoreResizeHandler handler,
                             BookmarkStore store)
```
    Call this when you want to set a resize handler that is invoked when a store needs a resize.
    
    Parameters:
    
    handler - The handler to invoke for the resize.
    
    store - The store to be resized.
  - setSubId
```
public void setSubId(Field sub)
```
    Sets the Subscription Identifier for the bookmark.
    
    Parameters:
    
    sub - The Field object to copy as the new SubId.
  - getRecoveryEntries
```
public void getRecoveryEntries(java.util.ArrayList<BookmarkRingBuffer.Entry> entryList_)
```
    Gets a list of recovery entries from the BookmarkRingBuffer.
    
    Parameters:
    
    entryList_ - The list to fill with the recovery entries.
  - setRecovery
```
@Deprecated
public long setRecovery()
```
    Deprecated.
    
    WARNING: @deprecated. Do Not Use. The notion of a separate "recovered bookmark" section within the ring buffer and the ability to re-log/re-order those entries into the main/active ring buffer section is an obsolete concept that hasn't been needed since the AMPS server stopped providing persisted acks for every message delivered on a replay (i.e. not needed since AMPS 4.0). The bookmark ring buffer has been simplified to remove this concept since a bug was discovered in it (AC-953). Old Docs: If there are presently no recovery entries in the ring buffer, this will convert all of the entries in the buffer into recovery entries.
    
    Returns:
    
    The index of the first recovery Entry.
  - getRecoveryEntries
```
@Deprecated
public java.util.ArrayList<BookmarkRingBuffer.Entry> getRecoveryEntries()
```
    Deprecated.
    
    WARNING: @deprecated. Do Not Use. The notion of a separate "recovered bookmark" section within the ring buffer and the ability to re-log/re-order those entries into the main/active ring buffer section is an obsolete concept that hasn't been needed since the AMPS server stopped providing persisted acks for every message delivered on a replay (i.e. not needed since AMPS 4.0). The bookmark ring buffer has been simplified to remove this concept since a bug was discovered in it (AC-953). Old Docs: Gets all of the recovery entries in a newly allocated ArrayList. If there are no recovery entries, this method returns null.
    
    Returns:
    
    The ArrayList of entries or null if none.
    
    See Also:
    
    setRecovery()
  - relog
```
@Deprecated
public long relog(long oldIndex,
                              BookmarkField bookmark)
```
    Deprecated.
    
    WARNING: @deprecated. Do Not Use. The notion of a separate "recovered bookmark" section within the ring buffer and the ability to re-log/re-order those entries into the main/active ring buffer section is an obsolete concept that hasn't been needed since the AMPS server stopped providing persisted acks for every message delivered on a replay (i.e. not needed since AMPS 4.0). The bookmark ring buffer has been simplified to remove this concept since a bug was discovered in it (AC-953). Old Docs: Re-logs the bookmark by copying an Entry to a new location and returning the index of that new location.
    
    Parameters:
    
    oldIndex - The index that the Entry was previously at.
    
    bookmark - The index to move.
    
    Returns:
    
    The index of the new Entry.
  - toString
```
public java.lang.String toString()
```
    Returns a debugging string representing ring buffer state.
    
    Overrides:
    
    toString in class java.lang.Object

Class BookmarkRingBuffer

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNSET_INDEX

Constructor Detail

BookmarkRingBuffer

Method Detail

reset

capacity

getByIndex

getLastDiscarded

isEmpty

getStartIndex

getEndIndex

log

discard

find

persisted

persisted

checkResize

setResizeHandler

setSubId

getRecoveryEntries

setRecovery

getRecoveryEntries

relog

toString