org.apache.jackrabbit.jcr2spi.state
Class Status

java.lang.Object
  org.apache.jackrabbit.jcr2spi.state.Status

public final class Status
extends Object

Status...

Field Summary

static int	_UNDEFINED_
static int	EXISTING 'existing', i.e. persistent state
static int	EXISTING_MODIFIED 'existing', i.e. persistent state that has been transiently modified (copy-on-write)
static int	EXISTING_REMOVED 'existing', i.e. persistent state that has been transiently removed (copy-on-write)
static int	INVALIDATED A state once read from persistent storage has been set to invalid.
static int	MODIFIED Temporary status used to mark a state, this is permanently modified either by saving transient changes, by workspace operations or by external modification.
static int	NEW 'new' state
static int	REMOVED a new state was removed and is now 'removed' or an existing item has been removed by a workspace operation or by an external modification.
static int	STALE_DESTROYED 'existing', i.e. persistent state that has been destroyed by somebody else
static int	STALE_MODIFIED 'existing', i.e. persistent state that has been persistently modified by somebody else

Constructor Summary

Status()

Method Summary

static String	getName(int status)
static int	getNewStatus(int oldStatus, int newStatusHint) Returns the given newStatusHint unless the new status collides with a pending modification or removal which results in a stale item state.
static boolean	isStale(int status) Returns true if status is one of: STALE_DESTROYED STALE_MODIFIED
static boolean	isTerminal(int status) Returns true if the given status is a terminal status, i.e.
static boolean	isTransient(int status) Returns true if status is one of: EXISTING_MODIFIED EXISTING_REMOVED NEW
static boolean	isValid(int status) Returns true if this item state is valid, that is its status is one of: EXISTING EXISTING_MODIFIED NEW
static boolean	isValidStatusChange(int oldStatus, int newStatus) Returns true, if the status of an item state can be changed from oldStatus to newStatus, and false if the change is illegal or if any of the given status flags is illegal.

Methods inherited from class java.lang.Object

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

Field Detail

_UNDEFINED_

public static final int _UNDEFINED_

See Also:

Constant Field Values

INVALIDATED

public static final int INVALIDATED

A state once read from persistent storage has been set to invalid. This means that the state needs to be re-fetched from persistent storage when accessed the next time.

See Also:

Constant Field Values

EXISTING

public static final int EXISTING

'existing', i.e. persistent state

See Also:

Constant Field Values

EXISTING_MODIFIED

public static final int EXISTING_MODIFIED

'existing', i.e. persistent state that has been transiently modified (copy-on-write)

See Also:

Constant Field Values

EXISTING_REMOVED

public static final int EXISTING_REMOVED

'existing', i.e. persistent state that has been transiently removed (copy-on-write)

See Also:

Constant Field Values

NEW

public static final int NEW

'new' state

See Also:

Constant Field Values

STALE_MODIFIED

public static final int STALE_MODIFIED

'existing', i.e. persistent state that has been persistently modified by somebody else

See Also:

Constant Field Values

STALE_DESTROYED

public static final int STALE_DESTROYED

'existing', i.e. persistent state that has been destroyed by somebody else

See Also:

Constant Field Values

MODIFIED

public static final int MODIFIED

Temporary status used to mark a state, this is permanently modified either by saving transient changes, by workspace operations or by external modification.

See Also:

Constant Field Values

REMOVED

public static final int REMOVED

a new state was removed and is now 'removed' or an existing item has been removed by a workspace operation or by an external modification.

See Also:

Constant Field Values

Constructor Detail

Status

public Status()

Method Detail

isTerminal

public static boolean isTerminal(int status)

Returns true if the given status is a terminal status, i.e. the given status one of:

• REMOVED
• STALE_DESTROYED

Parameters:

status -

Returns:

true if the given status is terminal.

isValid

public static boolean isValid(int status)

Returns true if this item state is valid, that is its status is one of:

• EXISTING
• EXISTING_MODIFIED
• NEW

Parameters:

status -

Returns:

true if the given status indicates a valid ItemState.

isStale

public static boolean isStale(int status)

Returns true if status is one of:

• STALE_DESTROYED
• STALE_MODIFIED

Parameters:

status - the status to check.

Returns:

true if status indicates that an item state is stale.

isTransient

public static boolean isTransient(int status)

Returns true if status is one of:

• EXISTING_MODIFIED
• EXISTING_REMOVED
• NEW

Parameters:

status - the status to check.

Returns:

true if status indicates that an item state is transiently modified.

isValidStatusChange

public static boolean isValidStatusChange(int oldStatus,
                                          int newStatus)

Returns true, if the status of an item state can be changed from oldStatus to newStatus, and false if the change is illegal or if any of the given status flags is illegal.

Parameters:

oldStatus -

newStatus -

Returns:

true if a status change from oldStatus to newStatus is allowed or if the two status are the same.

getNewStatus

public static int getNewStatus(int oldStatus,
                               int newStatusHint)

Returns the given newStatusHint unless the new status collides with a pending modification or removal which results in a stale item state.

Parameters:

oldStatus -

newStatusHint -

Returns:

new status that takes transient modification/removal into account.

getName

public static String getName(int status)

Parameters:

status - A valid status constant.

Returns:

Human readable status name for the given int.