com.exalead.papi.helper

Class CheckpointInfo

java.lang.Object

com.exalead.papi.helper.CheckpointInfo

Direct Known Subclasses:

FakePushAPI.MutableCheckpointInfo

public class CheckpointInfo
extends java.lang.Object

Base class representing checkpoints as known by the indexing chain. A checkpoint contains the following information:

• a name
• a value
• a synchronized state

Refer to PushAPI#setCheckpoint() and {@link PushAPI#getCheckpoint() for more information on how to set and retrieve checkpoints.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	name Checkpoint name.
protected CheckpointInfoIterator	parentIterator Parent iterator in an enumeration context.
protected boolean	synced Checkpoint synchronization state
protected java.lang.String	value Checkpoint value.

Constructor Summary

Constructors

Constructor and Description
CheckpointInfo() Constructor initializing an empty checkpoint.
CheckpointInfo(CheckpointInfoIterator parentIterator) Constructor specifying the parent iterator.
CheckpointInfo(java.lang.String name, java.lang.String value, boolean synced, CheckpointInfoIterator parentIterator) Constructor specifying the checkpoint content and the parent iterator.
CheckpointInfo(java.lang.String name, java.lang.String value, CheckpointInfoIterator parentIterator) Constructor specifying the checkpoint content and the parent iterator.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Clone a checkpoint by keeping the referencing to the checkpoint content and iterator.
boolean	equals(java.lang.Object obj) Compare a checkpoint with a given object.
java.lang.String	getName() Gets the checkpoint name.
CheckpointInfoIterator	getParentIterator() Get the parent iterator which generated this checkpoint (enumeration context).
java.lang.String	getValue() Get checkpoint value.
int	hashCode()
boolean	isSynced() Returns true if this checkpoint is synchronized (i.e safe), false otherwise.
protected void	setName(java.lang.String name) Set the checkpoint name.
protected void	setSynced(boolean synced) Set the checkpoint synchronized flag.
protected void	setValue(java.lang.String value) Set the checkpoint value.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

Checkpoint name.

value

protected java.lang.String value

Checkpoint value.

synced

protected boolean synced

Checkpoint synchronization state

parentIterator

protected CheckpointInfoIterator parentIterator

Parent iterator in an enumeration context.

Constructor Detail

CheckpointInfo

public CheckpointInfo()

Constructor initializing an empty checkpoint.

CheckpointInfo

public CheckpointInfo(CheckpointInfoIterator parentIterator)

Constructor specifying the parent iterator.

Parameters:

parentIterator - the parent iterator (only used in an enumeration context).

CheckpointInfo

public CheckpointInfo(java.lang.String name,
                      java.lang.String value,
                      CheckpointInfoIterator parentIterator)

Constructor specifying the checkpoint content and the parent iterator.

Parameters:

name - the checkpoint name

value - the checkpoint value

parentIterator - the parent iterator (only used in an enumeration context)

CheckpointInfo

public CheckpointInfo(java.lang.String name,
                      java.lang.String value,
                      boolean synced,
                      CheckpointInfoIterator parentIterator)

Constructor specifying the checkpoint content and the parent iterator.

Parameters:

name - the checkpoint name

value - the checkpoint value

synced - the checkpoint sync state

parentIterator - the parent iterator (only used in an enumeration context)

Method Detail

getName

public java.lang.String getName()

Gets the checkpoint name.

Returns:

the checkpoint name.

getValue

public java.lang.String getValue()

Get checkpoint value.

Returns:

the checkpoint value.

isSynced

public boolean isSynced()

Returns true if this checkpoint is synchronized (i.e safe), false otherwise.

Returns:

true if this checkpoint is synchronized (i.e safe), false otherwise

setName

protected void setName(java.lang.String name)

Set the checkpoint name. Only the name of the local object is changed (the Name of the checkpoint is not changed on server)

Parameters:

name - the checkpoint name.

setValue

protected void setValue(java.lang.String value)

Set the checkpoint value. Only the value of the local object is changed (the Value of the checkpoint is not changed on server)

Parameters:

value - the checkpoint value.

setSynced

protected void setSynced(boolean synced)

Set the checkpoint synchronized flag. A checkpoint is considered synchronized when flushed to disk.

Parameters:

synced - the checkpoint sync state

getParentIterator

public CheckpointInfoIterator getParentIterator()

Get the parent iterator which generated this checkpoint (enumeration context).

Returns:

the parent iterator which generated this checkpoint (enumeration context)

clone

public java.lang.Object clone()

Clone a checkpoint by keeping the referencing to the checkpoint content and iterator.

Overrides:

clone in class java.lang.Object

Returns:

a new instance of the checkpoint

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Compare a checkpoint with a given object.

Overrides:

equals in class java.lang.Object

Returns:

true if the object is a checkpoint with the same name and value, false otherwise.