com.crankuptheamps.client

Class BookmarkRingBuffer.Entry

java.lang.Object

com.crankuptheamps.client.BookmarkRingBuffer.Entry

Enclosing class:

BookmarkRingBuffer

public static class BookmarkRingBuffer.Entry
extends java.lang.Object

Represents a single entry in an array of bookmarks

Constructor Summary

Constructors

Constructor and Description
Entry() Initializes a new instance of the Entry class

Method Summary

Modifier and Type	Method and Description
BookmarkField	getBookmark() Gets the bookmark field of the Entry.
long	getIndex() Gets the index of the Entry in the Entry array.
boolean	isActive() Gets the active value of the Entry.
boolean	isPersisted() Deprecated.
BookmarkRingBuffer.Entry	setActive(boolean active) Sets the active value of the Entry.
BookmarkRingBuffer.Entry	setBookmark(Field f) Sets the bookmark field of the Entry.
BookmarkRingBuffer.Entry	setIndex(long index) Sets the index of the Entry in the Entry array.
BookmarkRingBuffer.Entry	setPersisted(boolean persisted) Deprecated.
java.lang.String	toString() Converts the Entry to a string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Entry

public Entry()

Initializes a new instance of the Entry class

Method Detail

setBookmark

public BookmarkRingBuffer.Entry setBookmark(Field f)

Sets the bookmark field of the Entry.

Parameters:

f - A Field object which contains the fields of the Bookmark.

Returns:

This instance.

getBookmark

public BookmarkField getBookmark()

Gets the bookmark field of the Entry.

Returns:

The bookmark field of the Entry.

setIndex

public BookmarkRingBuffer.Entry setIndex(long index)

Sets the index of the Entry in the Entry array.

Parameters:

index - The index to be set.

Returns:

This instance.

getIndex

public long getIndex()

Gets the index of the Entry in the Entry array.

Returns:

The index of the Entry.

isActive

public boolean isActive()

Gets the active value of the Entry.

Returns:

The active value of the Entry.

setActive

public BookmarkRingBuffer.Entry setActive(boolean active)

Sets the active value of the Entry.

Parameters:

active - the new value of active

Returns:

Returns this instance so that various operations can be chained together.

isPersisted

@Deprecated
public boolean isPersisted()

Deprecated.

WARNING: @deprecated. Do Not Use. Old Doc: Gets the persisted value of the Entry.

Returns:

The persisted value of the Entry.

setPersisted

@Deprecated
public BookmarkRingBuffer.Entry setPersisted(boolean persisted)

Deprecated.

WARNING: @deprecated. Do Not Use. Old Doc: Sets the persisted value of the Entry.

Parameters:

persisted - The persisted value of the Entry.

Returns:

The persisted value of the Entry.

toString

public java.lang.String toString()

Converts the Entry to a string.

Overrides:

toString in class java.lang.Object

Returns:

The converted Entry.