All Implemented Interfaces:: java.io.Serializable


public final class Node
 implements Serializable

Represents a node stored in JCR content repository.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public enum`	`Property`
`public class`	`Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`name`
`private final String`	`baseName`
`private final String`	`extension`
`private final Properties`	`properties`
`private final String`	`type`
`private final Node`	`parent`
`private final Boolean`	`root`
`private final List<Node>`	`parents`
`private final List<Node>`	`children`
`private final List<Node>`	`siblings`
`private final Boolean`	`exists`
`private final String`	`json`
`private final Repository`	`repository`
`private final String`	`path`

Constructor Summary

Constructors
Constructor	Description
`Node(Repository repository, String path, Map<String, Any> props)`

Method Summary

Modifier and Type	Method	Description
`final Sequence<Node>`	`parents()`	Get all parent nodes.
`final Node`	`child(String name)`	Get child node by name.
`final Boolean`	`hasChild(String name)`	Check if child node exists.
`final Sequence<Node>`	`children()`	Loop over all node child nodes.
`final Sequence<Node>`	`descendants()`
`final Sequence<Node>`	`siblings()`
`final Node`	`sibling(String name)`
`final Boolean`	`exists(Boolean recheck)`	Check if node exists.
`final RepositoryResult`	`save(Map<String, Any> properties)`	Create or update node in repository.
`final RepositoryResult`	`import(Map<String, Any> properties, String name, Boolean replace, Boolean replaceProperties)`	Import node into repository.
`final RepositoryResult`	`import(File file, String name, Boolean replace, Boolean replaceProperties)`	Import content structure defined in JSON file into repository.
`final RepositoryResult`	`delete()`	Delete node and all children from repository.
`final RepositoryResult`	`replace(Map<String, Any> properties)`	Delete node and creates it again.
`final Unit`	`reload()`	Synchronize on demand previously loaded properties of node (by default properties are loaded lazily).
`final Node`	`copy(String targetPath)`	Copy node to from source path to destination path.
`final Node`	`move(String targetPath, Boolean replace)`	Move node from source path to destination path.
`final Node`	`rename(String newName, Boolean replace)`	Change node name (effectively moves node).
`final Node`	`copyTo(String targetDir)`	Copy node to path pointing to folder with preserving original node name.
`final Node`	`copyFrom(String sourcePath)`	Copy node from other path to current path.
`final Sequence<Node>`	`traverse(Boolean self)`	Search nodes by traversing a node tree.
`final Sequence<Node>`	`query(Function1<QueryCriteria, Unit> criteria)`	Search nodes by querying repository under node path.
`final Sequence<Node>`	`query(QueryCriteria criteria)`	Search nodes by querying repository under node path.
`final RepositoryResult`	`saveProperty(String name, Object value)`	Update only single property of node.
`final RepositoryResult`	`deleteProperty(String name)`	Delete single property from node.
`final RepositoryResult`	`deleteProperties(Array<Out String> names)`	Delete multiple properties from node.
`final RepositoryResult`	`deleteProperties(Iterable<String> names)`	Delete multiple properties from node.
`final Boolean`	`hasProperty(String name)`	Check if node has property.
`final Boolean`	`hasProperties(Array<Out String> names)`	Check if node has properties.
`final Boolean`	`hasProperties(Iterable<String> names)`	Check if node has properties.
`final Unit`	`upload(File file)`	Upload file to node.
`final Unit`	`uploadFile(File file)`	Upload asset using default Sling endpoint.
`final Unit`	`uploadDamAsset(File file)`	Upload asset using dedicated DAM endpoint.
`final Node`	`uploadTo(File file)`	Upload file to current folder node with preserving original file name.
`final <T extends Any> T`	`read(Function1<InputStream, T> reader)`	Read file stored in node.
`final Unit`	`download(String targetFilePath)`	Download file stored in node to specified local file.
`final Unit`	`download(File targetFile)`	Download file stored in node to specified local file.
`final File`	`download()`	Download file stored in node to temporary directory with preserving file name.
`final File`	`downloadTo(String targetDirPath)`	Download file stored in node to specified local directory with preserving file name.
`final File`	`downloadTo(File targetDir)`	Download file stored in node to specified local directory with preserving file name.
`final File`	`downloadPackage(Function1<PackageDefinition, Unit> options)`	Download node as CRX package.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final String`	`getName()`
`final String`	`getBaseName()`
`final String`	`getExtension()`
`final Properties`	`getProperties()`
`final String`	`getType()`
`final Node`	`getParent()`
`final Boolean`	`getRoot()`
`final List<Node>`	`getParents()`
`final List<Node>`	`getChildren()`
`final List<Node>`	`getSiblings()`
`final Boolean`	`getExists()`
`final String`	`getJson()`
`final Repository`	`getRepository()`
`final String`	`getPath()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Node

Node(Repository repository, String path, Map<String, Any> props)

Method Detail

parents
```
 final Sequence<Node> parents()
```
Get all parent nodes.

child
```
 final Node child(String name)
```
Get child node by name.

hasChild
```
 final Boolean hasChild(String name)
```
Check if child node exists.

children
```
 final Sequence<Node> children()
```
Loop over all node child nodes.

descendants
```
 final Sequence<Node> descendants()
```

siblings
```
 final Sequence<Node> siblings()
```

sibling
```
 final Node sibling(String name)
```

exists
```
 final Boolean exists(Boolean recheck)
```
Check if node exists.

save

 final RepositoryResult save(Map<String, Any> properties)

Create or update node in repository.

import

 final RepositoryResult import(Map<String, Any> properties, String name, Boolean replace, Boolean replaceProperties)

Import node into repository.

import

 final RepositoryResult import(File file, String name, Boolean replace, Boolean replaceProperties)

Import content structure defined in JSON file into repository.

delete
```
 final RepositoryResult delete()
```
Delete node and all children from repository.

replace

 final RepositoryResult replace(Map<String, Any> properties)

Delete node and creates it again.

reload
```
 final Unit reload()
```
Synchronize on demand previously loaded properties of node (by default properties are loaded lazily).

copy
```
 final Node copy(String targetPath)
```
Copy node to from source path to destination path.

move

 final Node move(String targetPath, Boolean replace)

Move node from source path to destination path.

rename

 final Node rename(String newName, Boolean replace)

Change node name (effectively moves node).

copyTo
```
 final Node copyTo(String targetDir)
```
Copy node to path pointing to folder with preserving original node name.

copyFrom
```
 final Node copyFrom(String sourcePath)
```
Copy node from other path to current path.

traverse

 final Sequence<Node> traverse(Boolean self)

Search nodes by traversing a node tree.

query

 final Sequence<Node> query(Function1<QueryCriteria, Unit> criteria)

Search nodes by querying repository under node path.

query

 final Sequence<Node> query(QueryCriteria criteria)

Search nodes by querying repository under node path.

saveProperty

 final RepositoryResult saveProperty(String name, Object value)

Update only single property of node.

deleteProperty

 final RepositoryResult deleteProperty(String name)

Delete single property from node.

deleteProperties

 final RepositoryResult deleteProperties(Array<Out String> names)

Delete multiple properties from node.

deleteProperties

 final RepositoryResult deleteProperties(Iterable<String> names)

Delete multiple properties from node.

hasProperty

 final Boolean hasProperty(String name)

Check if node has property.

hasProperties

 final Boolean hasProperties(Array<Out String> names)

Check if node has properties.

hasProperties

 final Boolean hasProperties(Iterable<String> names)

Check if node has properties.

upload
```
 final Unit upload(File file)
```
Upload file to node.

uploadFile
```
 final Unit uploadFile(File file)
```
Upload asset using default Sling endpoint.

uploadDamAsset
```
 final Unit uploadDamAsset(File file)
```
Upload asset using dedicated DAM endpoint.

uploadTo
```
 final Node uploadTo(File file)
```
Upload file to current folder node with preserving original file name.

read

 final <T extends Any> T read(Function1<InputStream, T> reader)

Read file stored in node.

download
```
 final Unit download(String targetFilePath)
```
Download file stored in node to specified local file.

download
```
 final Unit download(File targetFile)
```
Download file stored in node to specified local file.

download
```
 final File download()
```
Download file stored in node to temporary directory with preserving file name.

downloadTo
```
 final File downloadTo(String targetDirPath)
```
Download file stored in node to specified local directory with preserving file name.

downloadTo
```
 final File downloadTo(File targetDir)
```
Download file stored in node to specified local directory with preserving file name.

downloadPackage

 final File downloadPackage(Function1<PackageDefinition, Unit> options)

Download node as CRX package.

equals
```
 Boolean equals(Object other)
```

hashCode
```
 Integer hashCode()
```

toString
```
 String toString()
```

getName
```
 final String getName()
```

getBaseName
```
 final String getBaseName()
```

getExtension
```
 final String getExtension()
```

getProperties
```
 final Properties getProperties()
```

getType
```
 final String getType()
```

getParent
```
 final Node getParent()
```

getRoot
```
 final Boolean getRoot()
```

getParents
```
 final List<Node> getParents()
```

getChildren
```
 final List<Node> getChildren()
```

getSiblings
```
 final List<Node> getSiblings()
```

getExists
```
 final Boolean getExists()
```

getJson
```
 final String getJson()
```

getRepository
```
 final Repository getRepository()
```

getPath
```
 final String getPath()
```

Class Node

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Node

Method Detail

parents

child

hasChild

children

descendants

siblings

sibling

exists

save

import

import

delete

replace

reload

copy

move

rename

copyTo

copyFrom

traverse

query

query

saveProperty

deleteProperty

deleteProperties

deleteProperties

hasProperty

hasProperties

hasProperties

upload

uploadFile

uploadDamAsset

uploadTo

read

download

download

download

downloadTo

downloadTo

downloadPackage

equals

hashCode

toString

getName

getBaseName

getExtension

getProperties

getType

getParent

getRoot

getParents

getChildren

getSiblings

getExists

getJson

getRepository

getPath