public class NodeDelegate extends ItemDelegate
NodeDelegate
serve as internal representations of Node
s.
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.sessionDelegate
Constructor and Description |
---|
NodeDelegate(SessionDelegate sessionDelegate,
org.apache.jackrabbit.oak.api.Tree tree) |
Modifier and Type | Method and Description |
---|---|
@Nullable NodeDelegate |
addChild(String name,
String typeName)
Add a child node
|
void |
addMixin(String typeName) |
boolean |
canAddMixin(String typeName) |
boolean |
exists()
Determine whether the underlying item exists
|
@Nullable NodeDelegate |
getChild(String relPath)
Get child node
|
long |
getChildCount(long max)
Get the number of child nodes
|
@NotNull Iterator<NodeDelegate> |
getChildren()
Returns an iterator for traversing all the children of this node.
|
@NotNull String |
getIdentifier() |
@Nullable NodeDelegate |
getLock() |
String |
getLockOwner() |
@NotNull String |
getName()
Get the name of this item
|
@Nullable NodeDelegate |
getParent()
Get the parent of this item or
null . |
@NotNull String |
getPath()
Get the path of this item
|
@NotNull Iterator<PropertyDelegate> |
getProperties()
Get the properties of the node
|
@NotNull PropertyDelegate |
getProperty(String relPath)
Get a property.
|
long |
getPropertyCount()
Get the number of properties of the node
|
@Nullable PropertyDelegate |
getPropertyOrNull(String relPath)
Get a property
|
@Nullable org.apache.jackrabbit.oak.api.Tree.Status |
getStatus()
Get the status of this item.
|
@NotNull org.apache.jackrabbit.oak.api.Tree |
getTree() |
boolean |
holdsLock(boolean deep)
Checks whether this node holds a lock.
|
boolean |
isLocked()
Checks whether this node is locked, either directly or through
a deep lock on an ancestor.
|
boolean |
isLockOwner(String user) |
boolean |
isProtected() |
boolean |
isRoot()
Determine whether this is the root node
|
void |
lock(boolean isDeep) |
void |
orderBefore(String source,
String target) |
boolean |
remove()
Remove this node.
|
void |
removeMixin(String typeName) |
void |
setMixins(Set<String> mixinNames) |
void |
setOrderableChildren(boolean enable)
Enables or disabled orderable children on the underlying tree.
|
@NotNull PropertyDelegate |
setProperty(org.apache.jackrabbit.oak.api.PropertyState propertyState,
boolean exactTypeMatch,
boolean setProtected)
Set a property
|
String |
toString() |
void |
unlock() |
void |
updateMixins(Set<String> addMixinNames,
Set<String> removedOakMixinNames) |
checkAlive, checkUpdate, save, update
public NodeDelegate(SessionDelegate sessionDelegate, org.apache.jackrabbit.oak.api.Tree tree)
@NotNull public @NotNull String getName()
ItemDelegate
getName
in class ItemDelegate
@NotNull public @NotNull String getPath()
ItemDelegate
getPath
in class ItemDelegate
@Nullable public @Nullable NodeDelegate getParent()
ItemDelegate
null
.getParent
in class ItemDelegate
null
for root or if the parent
is not accessible.public boolean exists()
ItemDelegate
exists
in class ItemDelegate
true
the underlying tree exists, false
otherwise.@Nullable public @Nullable org.apache.jackrabbit.oak.api.Tree.Status getStatus()
ItemDelegate
getStatus
in class ItemDelegate
Tree.Status
of this item or null
if not available.@NotNull public @NotNull String getIdentifier() throws InvalidItemStateException
InvalidItemStateException
public boolean isProtected() throws InvalidItemStateException
isProtected
in class ItemDelegate
InvalidItemStateException
public boolean isRoot() throws InvalidItemStateException
true
iff this is the root nodeInvalidItemStateException
public long getPropertyCount() throws InvalidItemStateException
InvalidItemStateException
@Nullable public @Nullable PropertyDelegate getPropertyOrNull(String relPath) throws RepositoryException
relPath
- oak pathrelPath
or null
if
no such property existsRepositoryException
@NotNull public @NotNull PropertyDelegate getProperty(String relPath) throws RepositoryException
getPropertyOrNull(String)
this
method never returns null
. In the case where no property exists
at the given path, the returned property delegate throws an
InvalidItemStateException
on access. See See OAK-395.relPath
- oak pathrelPath
.RepositoryException
@NotNull public @NotNull Iterator<PropertyDelegate> getProperties() throws InvalidItemStateException
InvalidItemStateException
public long getChildCount(long max) throws InvalidItemStateException
If an implementation does know the exact value, it returns it (even if the value is higher than max). If the implementation does not know the exact value, and the child node count is higher than max, it may return Long.MAX_VALUE. The cost of the operation is at most O(max).
max
- the maximum valueInvalidItemStateException
@Nullable public @Nullable NodeDelegate getChild(String relPath) throws RepositoryException
relPath
- oak pathrelPath
or null
if
no such node existsRepositoryException
@NotNull public @NotNull Iterator<NodeDelegate> getChildren() throws InvalidItemStateException
InvalidItemStateException
public void orderBefore(String source, String target) throws ItemNotFoundException, InvalidItemStateException
public boolean canAddMixin(String typeName) throws RepositoryException
RepositoryException
public void addMixin(String typeName) throws RepositoryException
RepositoryException
public void removeMixin(String typeName) throws RepositoryException
RepositoryException
public void setMixins(Set<String> mixinNames) throws RepositoryException
RepositoryException
public void updateMixins(Set<String> addMixinNames, Set<String> removedOakMixinNames) throws RepositoryException
RepositoryException
@NotNull public @NotNull PropertyDelegate setProperty(org.apache.jackrabbit.oak.api.PropertyState propertyState, boolean exactTypeMatch, boolean setProtected) throws RepositoryException
RepositoryException
@Nullable public @Nullable NodeDelegate addChild(String name, String typeName) throws RepositoryException
name
- Oak name of the new child nodetypeName
- Oak name of the type of the new child node,
or null
if a default type should be usednull
if such a node already existsRepositoryException
public boolean remove() throws InvalidItemStateException
remove
in class ItemDelegate
true
if the node was removed; false
otherwise.InvalidItemStateException
public void setOrderableChildren(boolean enable) throws InvalidItemStateException
enable
- whether to enable or disable orderable children.InvalidItemStateException
public boolean isLocked()
@Nullable public @Nullable NodeDelegate getLock()
public boolean holdsLock(boolean deep)
deep
- if true
, only check for deep lockspublic String getLockOwner()
public boolean isLockOwner(String user)
public void lock(boolean isDeep) throws RepositoryException
RepositoryException
public void unlock() throws RepositoryException
RepositoryException
@NotNull public @NotNull org.apache.jackrabbit.oak.api.Tree getTree() throws InvalidItemStateException
InvalidItemStateException
Copyright © 2012–2020 The Apache Software Foundation. All rights reserved.