org.apache.jackrabbit.oak.jcr.delegate

Class PropertyDelegate

java.lang.Object

org.apache.jackrabbit.oak.jcr.delegate.ItemDelegate

org.apache.jackrabbit.oak.jcr.delegate.PropertyDelegate

public class PropertyDelegate
extends ItemDelegate

PropertyDelegate serve as internal representations of Propertys. Most methods of this class throw an InvalidItemStateException exception if the instance is stale. An instance is stale if the underlying items does not exist anymore.

Field Summary

Fields inherited from class org.apache.jackrabbit.oak.jcr.delegate.ItemDelegate

sessionDelegate

Method Summary

Modifier and Type	Method and Description
boolean	exists() Determine whether the underlying item exists
boolean	getBoolean()
java.lang.String	getDate()
@NotNull PropertyState	getMultiState()
@NotNull java.lang.String	getName() Get the name of this item
@Nullable NodeDelegate	getParent() Get the parent of this item or null.
@NotNull java.lang.String	getPath() Get the path of this item
@NotNull PropertyState	getPropertyState()
@NotNull PropertyState	getSingleState()
@Nullable Tree.Status	getStatus() Get the status of this item.
java.lang.String	getString()
boolean	isProtected()
boolean	remove() Remove the property
void	setState(@NotNull PropertyState propertyState)
java.lang.String	toString()
protected void	update() The session has been updated since the last time this property delegate was accessed, so we need to re-retrieve the property state to get any potential updates.

Methods inherited from class org.apache.jackrabbit.oak.jcr.delegate.ItemDelegate

checkAlive, checkUpdate, save

Methods inherited from class java.lang.Object

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

Method Detail

update

protected void update()

The session has been updated since the last time this property delegate was accessed, so we need to re-retrieve the property state to get any potential updates. It might also be that this property was removed, in which case the state reference will be null.

Overrides:

update in class ItemDelegate

getName

@NotNull
public @NotNull java.lang.String getName()

Description copied from class: ItemDelegate

Get the name of this item

Specified by:

getName in class ItemDelegate

Returns:

oak name of this item

getPath

@NotNull
public @NotNull java.lang.String getPath()

Description copied from class: ItemDelegate

Get the path of this item

Specified by:

getPath in class ItemDelegate

Returns:

oak path of this item

getParent

@Nullable
public @Nullable NodeDelegate getParent()

Description copied from class: ItemDelegate

Get the parent of this item or null.

Specified by:

getParent in class ItemDelegate

Returns:

parent of this item or null for root or if the parent is not accessible.

exists

public boolean exists()

Description copied from class: ItemDelegate

Determine whether the underlying item exists

Specified by:

exists in class ItemDelegate

Returns:

true the underlying tree exists, false otherwise.

getStatus

@Nullable
public @Nullable Tree.Status getStatus()

Description copied from class: ItemDelegate

Get the status of this item.

Specified by:

getStatus in class ItemDelegate

Returns:

Tree.Status of this item or null if not available.

isProtected

public boolean isProtected()
                    throws InvalidItemStateException

Specified by:

isProtected in class ItemDelegate

Throws:

InvalidItemStateException

getPropertyState

@NotNull
public @NotNull PropertyState getPropertyState()
                                                 throws InvalidItemStateException

Throws:

InvalidItemStateException

getSingleState

@NotNull
public @NotNull PropertyState getSingleState()
                                               throws InvalidItemStateException,
                                                      ValueFormatException

Throws:

InvalidItemStateException

ValueFormatException

getBoolean

public boolean getBoolean()
                   throws ValueFormatException,
                          InvalidItemStateException

Throws:

ValueFormatException

InvalidItemStateException

getString

public java.lang.String getString()
                           throws ValueFormatException,
                                  InvalidItemStateException

Throws:

ValueFormatException

InvalidItemStateException

getDate

public java.lang.String getDate()
                         throws ValueFormatException,
                                InvalidItemStateException

Throws:

ValueFormatException

InvalidItemStateException

getMultiState

@NotNull
public @NotNull PropertyState getMultiState()
                                              throws InvalidItemStateException,
                                                     ValueFormatException

Throws:

InvalidItemStateException

ValueFormatException

setState

public void setState(@NotNull
                     @NotNull PropertyState propertyState)

remove

public boolean remove()

Remove the property

Specified by:

remove in class ItemDelegate

Returns:

true if this item was removed; or false if this is the root node that can't be removed

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object