net.sourceforge.chessshell.plugin.api

Class BookmarkChangeDescription

java.lang.Object

net.sourceforge.chessshell.plugin.api.BookmarkChangeDescription

public final class BookmarkChangeDescription
extends java.lang.Object

A description of an update to be made on a bookmark.

Field Summary

Fields

Modifier and Type	Field and Description
private int	bookmarkIndex
private java.lang.String	gameTrack

Constructor Summary

Constructors

Constructor and Description
BookmarkChangeDescription(int bookmarkIndex, java.lang.String gameTrack)

Method Summary

Modifier and Type	Method and Description
int	getBookmarkId() Return the bookmark id (1-based index).
java.lang.String	getGameTrack() Return the 'game track' - a description of how to reach the bookmarked position from the initial position of the game.

Methods inherited from class java.lang.Object

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

Field Detail

bookmarkIndex

private final int bookmarkIndex

gameTrack

private final java.lang.String gameTrack

Constructor Detail

BookmarkChangeDescription

public BookmarkChangeDescription(int bookmarkIndex,
                                 java.lang.String gameTrack)

Parameters:

bookmarkIndex - - 0-based index among all bookmarks.

gameTrack - @see #getGameTrack().

Method Detail

getBookmarkId

public int getBookmarkId()

Return the bookmark id (1-based index).

getGameTrack

public java.lang.String getGameTrack()

Return the 'game track' - a description of how to reach the bookmarked position from the initial position of the game.