org.mule.extension.file.common.api

Class TreeNode

java.lang.Object

org.mule.extension.file.common.api.TreeNode

All Implemented Interfaces:

Serializable, Iterable

public class TreeNode
extends Object
implements Serializable, Iterable

Represents a node on a file system tree.

It contains an Result which represents the file this node points to.

Because this node itself can point to a directory, it also contains a List of #getChilds() childs).

The node can also optionally have a {@link #getContent() content}, which will return {@code null} if the node points to a directory.

This class also implements the {@link Iterable} interface making it suitable for use with componets such as {@code foreach} or {@code batch}. The methods in such interface are implemented by delegating into the {@link #getChilds()} list.

Instances are immutable and are to be created through a {@link Builder} instance.

Since:

4.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TreeNode.Builder Implementation of the buidler design pattern to create instances of TreeNode

Method Summary

Modifier and Type	Method and Description
FileAttributes	getAttributes()
List<TreeNode>	getChilds()
InputStream	getContent()
org.mule.runtime.api.metadata.MediaType	getMediaType()
Iterator	iterator()
Spliterator	spliterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

getChilds

public List<TreeNode> getChilds()

Returns:

a immutable List with this node's childs

getAttributes

public FileAttributes getAttributes()

Returns:

a FileAttributes object with the node's metadata

getMediaType

public org.mule.runtime.api.metadata.MediaType getMediaType()

Returns:

a DataType with type metadata about the referenced node

getContent

public InputStream getContent()

Returns:

an InputStream if the node is a file, or null if it's a directory

iterator

public Iterator iterator()

Specified by:

iterator in interface Iterable

Returns:

the getChilds() Iterator

spliterator

public Spliterator spliterator()

Specified by:

spliterator in interface Iterable

Returns:

the getChilds() Spliterator