com.enonic.xp.node.Node Maven / Gradle / Ivy
The newest version!
package com.enonic.xp.node;
import java.time.Instant;
import java.time.temporal.ChronoUnit;
import java.util.Objects;
import com.google.common.base.Preconditions;
import com.enonic.xp.annotation.PublicApi;
import com.enonic.xp.data.PropertyTree;
import com.enonic.xp.index.ChildOrder;
import com.enonic.xp.index.IndexConfig;
import com.enonic.xp.index.IndexConfigDocument;
import com.enonic.xp.index.PatternIndexConfigDocument;
import com.enonic.xp.security.acl.AccessControlList;
@PublicApi
public final class Node
{
public static final NodeId ROOT_UUID = NodeId.from( "000-000-000-000" );
private final NodeId id;
private final NodeName name;
private final NodePath parentPath;
private final NodeType nodeType;
private final NodePath path;
private final Instant timestamp;
private final PropertyTree data;
private final IndexConfigDocument indexConfigDocument;
private final ChildOrder childOrder;
private final Long manualOrderValue;
private final AccessControlList permissions;
private final boolean inheritPermissions;
private final AttachedBinaries attachedBinaries;
private final NodeVersionId nodeVersionId;
private Node( final Builder builder )
{
Preconditions.checkNotNull( builder.permissions, "permissions are required" );
Preconditions.checkNotNull( builder.data, "data are required" );
this.id = builder.id;
this.nodeType = builder.nodeType;
this.data = builder.data;
this.childOrder = builder.childOrder;
this.manualOrderValue = builder.manualOrderValue;
this.permissions = builder.permissions;
this.inheritPermissions = builder.inheritPermissions;
this.attachedBinaries = builder.attachedBinaries;
this.timestamp = builder.timestamp;
this.nodeVersionId = builder.nodeVersionId;
if ( ROOT_UUID.equals( this.id ) )
{
this.parentPath = null;
this.path = NodePath.ROOT;
this.name = NodeName.ROOT;
}
else if ( builder.parentPath != null && builder.name != null )
{
this.parentPath = builder.parentPath;
this.name = builder.name;
this.path = new NodePath( this.parentPath, this.name );
}
else
{
this.parentPath = builder.parentPath;
this.name = builder.name;
this.path = null;
}
this.indexConfigDocument = Objects.requireNonNullElseGet( builder.indexConfigDocument, PatternIndexConfigDocument.create()
.defaultConfig( IndexConfig.BY_TYPE )::build );
}
public boolean isRoot()
{
return ROOT_UUID.equals( this.id );
}
public NodeName name()
{
return name;
}
public NodePath parentPath()
{
return parentPath;
}
public NodePath path()
{
return path;
}
public NodeId id()
{
return id;
}
public Instant getTimestamp()
{
return timestamp;
}
public PropertyTree data()
{
return this.data;
}
public IndexConfigDocument getIndexConfigDocument()
{
return indexConfigDocument;
}
public ChildOrder getChildOrder()
{
return childOrder;
}
public Long getManualOrderValue()
{
return manualOrderValue;
}
public AccessControlList getPermissions()
{
return permissions;
}
public boolean inheritsPermissions()
{
return inheritPermissions;
}
public NodeType getNodeType()
{
return nodeType;
}
public AttachedBinaries getAttachedBinaries()
{
return attachedBinaries;
}
@Deprecated
public NodeState getNodeState()
{
return NodeState.DEFAULT;
}
public NodeVersionId getNodeVersionId()
{
return nodeVersionId;
}
public void validateForIndexing()
{
Preconditions.checkNotNull( this.id, "Id must be set" );
Preconditions.checkNotNull( this.indexConfigDocument, "EntityIndexConfig must be set" );
}
@Override
public String toString()
{
return path == null ? "/" : this.path.toString();
}
public static Builder create()
{
return new Builder();
}
public static Builder create( final NodeVersion nodeVersion )
{
return new Builder().
id( nodeVersion.getId() ).
nodeType( nodeVersion.getNodeType() ).
data( nodeVersion.getData() ).
indexConfigDocument( nodeVersion.getIndexConfigDocument() ).
childOrder( nodeVersion.getChildOrder() ).
manualOrderValue( nodeVersion.getManualOrderValue() ).
permissions( nodeVersion.getPermissions() ).
inheritPermissions( nodeVersion.isInheritPermissions() ).
attachedBinaries( nodeVersion.getAttachedBinaries() );
}
public static Builder create( final NodeId id )
{
return new Builder( id );
}
public static Builder create( final Node node )
{
return new Builder( node );
}
public static Builder createRoot()
{
return new Builder( ROOT_UUID );
}
public static class Builder
{
private NodeId id;
private PropertyTree data = new PropertyTree();
private IndexConfigDocument indexConfigDocument;
private NodeName name;
private NodePath parentPath;
private Instant timestamp;
private ChildOrder childOrder = ChildOrder.defaultOrder();
private Long manualOrderValue;
private AccessControlList permissions = AccessControlList.empty();
private boolean inheritPermissions;
private NodeType nodeType = NodeType.DEFAULT_NODE_COLLECTION;
private AttachedBinaries attachedBinaries = AttachedBinaries.empty();
private NodeVersionId nodeVersionId;
public Builder()
{
super();
}
public Builder( final NodeId id )
{
this.id = id;
}
public Builder( final Node node )
{
this.id = node.id;
this.name = node.name;
this.parentPath = node.parentPath;
this.nodeType = node.nodeType;
this.data = node.data;
this.indexConfigDocument = node.indexConfigDocument;
this.childOrder = node.childOrder;
this.manualOrderValue = node.manualOrderValue;
this.permissions = node.permissions;
this.inheritPermissions = node.inheritPermissions;
this.attachedBinaries = node.attachedBinaries;
this.timestamp = node.timestamp;
this.nodeVersionId = node.nodeVersionId;
}
public Builder( final NodeId id, final NodeName name )
{
this.id = id;
this.name = name;
}
public Builder name( final String value )
{
this.name( NodeName.from( value ) );
return this;
}
public Builder name( final NodeName value )
{
this.name = value;
return this;
}
@Deprecated
public Builder path( final String value )
{
this.parentPath = new NodePath( value );
return this;
}
public Builder parentPath( final NodePath value )
{
this.parentPath = value;
return this;
}
public Builder id( final NodeId id )
{
this.id = id;
return this;
}
public Builder data( final PropertyTree value )
{
this.data = value;
return this;
}
public Builder indexConfigDocument( final IndexConfigDocument indexConfigDocument )
{
this.indexConfigDocument = indexConfigDocument;
return this;
}
public Builder childOrder( final ChildOrder childOrder )
{
this.childOrder = childOrder;
return this;
}
public Builder manualOrderValue( final Long manualOrderValue )
{
this.manualOrderValue = manualOrderValue;
return this;
}
public Builder permissions( final AccessControlList permissions )
{
this.permissions = permissions;
return this;
}
public Builder inheritPermissions( final boolean inheritPermissions )
{
this.inheritPermissions = inheritPermissions;
return this;
}
public Builder nodeType( final NodeType nodeType )
{
this.nodeType = nodeType;
return this;
}
public Builder attachedBinaries( final AttachedBinaries attachedBinaries )
{
this.attachedBinaries = attachedBinaries;
return this;
}
@Deprecated
public Builder nodeState( final NodeState nodeState )
{
return this;
}
public Builder timestamp( final Instant timestamp )
{
this.timestamp = timestamp;
if ( timestamp != null )
{
this.timestamp = timestamp.truncatedTo( ChronoUnit.MILLIS );
}
return this;
}
public Builder nodeVersionId( final NodeVersionId nodeVersionId )
{
this.nodeVersionId = nodeVersionId;
return this;
}
private void validate()
{
if ( ROOT_UUID.equals( this.id ) )
{
Preconditions.checkNotNull( this.childOrder );
}
}
public Node build()
{
this.validate();
return new Node( this );
}
}
@Override
public boolean equals( final Object o )
{
if ( this == o )
{
return true;
}
if ( o == null || getClass() != o.getClass() )
{
return false;
}
final Node node = (Node) o;
return Objects.equals( id, node.id ) &&
Objects.equals( name, node.name ) &&
Objects.equals( nodeType, node.nodeType ) &&
Objects.equals( parentPath, node.parentPath ) &&
Objects.equals( inheritPermissions, node.inheritPermissions ) &&
Objects.equals( manualOrderValue, node.manualOrderValue ) &&
Objects.equals( childOrder, node.childOrder ) &&
Objects.equals( permissions, node.permissions ) &&
Objects.equals( data, node.data ) &&
Objects.equals( attachedBinaries, node.attachedBinaries ) &&
Objects.equals( nodeVersionId, node.nodeVersionId ) &&
Objects.equals( indexConfigDocument, node.indexConfigDocument );
}
@Override
public int hashCode()
{
return Objects.hash( id, name, parentPath, nodeType, inheritPermissions, manualOrderValue, childOrder, permissions, data,
indexConfigDocument, attachedBinaries, nodeVersionId );
}
}