org.jamplate.impl.util

Class Trees

java.lang.Object

org.jamplate.impl.util.Trees

public final class Trees
extends java.lang.Object

Common operations functions for trees.

Since:

0.2.0 ~2021.05.18

Version:

0.2.0

Author:

LSafer

Method Summary

Modifier and Type	Method and Description
static @NotNull java.util.Set<Tree>	children(@NotNull Tree tree) Collect all the children of the given tree and add them to the given result.
static @NotNull java.util.Set<Tree>	collect(@NotNull Tree tree) Collect all the relatives to the given tree (including the tree itself).
static @NotNull java.util.List<Tree>	flatChildren(@NotNull Tree tree) Return an ordered list containing the children of the given tree alongside with newly created trees that fills the gaps between the children of the given tree.
static int	line(@NotNull Tree tree) Get the line of the given tree on its document.
static int	positionInLine(@NotNull Tree tree) Return the position of the given tree on its line.
static @NotNull java.lang.CharSequence	read(@NotNull Tree tree) Read the source-code of the given tree.
static @Nullable java.lang.CharSequence	readLine(@NotNull Tree tree) Read the whole line that the given tree is at on its document.
static @NotNull Tree	root(@NotNull Tree tree) Return the root tree of the given tree.
static @NotNull Tree[]	toArray(@NotNull Tree tree) Return an array containing the current children of the given tree.

Methods inherited from class java.lang.Object

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

Method Detail

children

@NotNull
 @Contract(value="_->new",
          pure=true)
public static @NotNull java.util.Set<Tree> children(@NotNull
                                                                                                                @NotNull Tree tree)

Collect all the children of the given tree and add them to the given result.

Parameters:

tree - the tree to get its children.

Returns:

a set containing all the children of the given tree.

Throws:

java.lang.NullPointerException - if the given tree is null.

Since:

0.2.0 ~2021.05.23

collect

@NotNull
 @Contract(value="_->new",
          pure=true)
public static @NotNull java.util.Set<Tree> collect(@NotNull
                                                                                                               @NotNull Tree tree)

Collect all the relatives to the given tree (including the tree itself).

Parameters:

tree - the tree to collect its relatives.

Returns:

a set containing all the relatives of the given tree.

Throws:

java.lang.NullPointerException - if the given tree is null.

Since:

0.2.0 ~2021.05.17

flatChildren

@NotNull
 @Contract(value="_->new",
          pure=true)
public static @NotNull java.util.List<Tree> flatChildren(@NotNull
                                                                                                                     @NotNull Tree tree)

Return an ordered list containing the children of the given tree alongside with newly created trees that fills the gaps between the children of the given tree.

Parameters:

tree - the tree.

Returns:

an ordered list containing the actual and possible children of the given tree.

Throws:

java.lang.NullPointerException - if the given tree is null.

Since:

0.2.0 ~2021.05.24

line

@Contract(pure=true)
public static int line(@NotNull
                                             @NotNull Tree tree)

Get the line of the given tree on its document.

Parameters:

tree - the tree to get its line.

Returns:

the line of the given tree.

Throws:

java.lang.NullPointerException - if the given tree is null.

java.io.IOError - if any I/O error occurred while reading.

DocumentNotFoundError - if the document of the given tree is unavailable.

Since:

0.2.0 ~2021.05.23

positionInLine

@Contract(pure=true)
public static int positionInLine(@NotNull
                                                       @NotNull Tree tree)

Return the position of the given tree on its line.

Parameters:

tree - the tree to get its position in its line.

Returns:

the position of the given tree on its line.

Throws:

java.lang.NullPointerException - if the given tree is null.

java.io.IOError - if any I/O error occurred while reading.

DocumentNotFoundError - if the document of the given tree is unavailable.

Since:

0.2.0 ~2021.05.24

read

@NotNull
 @Contract(pure=true)
public static @NotNull java.lang.CharSequence read(@NotNull
                                                                                    @NotNull Tree tree)

Read the source-code of the given tree.

Parameters:

tree - the tree to read its source-code.

Returns:

the source code of the given tree.

Throws:

java.lang.NullPointerException - if the given tree is null.

java.io.IOError - if any I/O error occurred while reading.

DocumentNotFoundError - if the document of the given tree is unavailable.

Since:

0.2.0 ~2021.05.21

readLine

@Nullable
 @Contract(pure=true)
public static @Nullable java.lang.CharSequence readLine(@NotNull
                                                                                          @NotNull Tree tree)

Read the whole line that the given tree is at on its document.

Parameters:

tree - the tree to read the line it is in.

Returns:

the text of the line the given tree is at.

Throws:

java.lang.NullPointerException - if the given tree is null.

java.io.IOError - if any I/O error occurred while reading.

DocumentNotFoundError - if the document of the given tree is unavailable.

Since:

0.2.0 ~2021.05.24

root

@NotNull
 @Contract(pure=true)
public static @NotNull Tree root(@NotNull
                                                                  @NotNull Tree tree)

Return the root tree of the given tree.

Parameters:

tree - the tree to get its root tree.

Returns:

the root tree of the given tree.

Throws:

java.lang.NullPointerException - if the given tree is null.

Since:

0.2.0 ~2021.05.31

toArray

@NotNull
 @Contract(value="_->new",
          pure=true)
public static @NotNull Tree[] toArray(@NotNull
                                                                                                  @NotNull Tree tree)

Return an array containing the current children of the given tree.

Parameters:

tree - the tree to get an array containing its current children.

Returns:

a new array containing the children of the given tree.

Throws:

java.lang.NullPointerException - if the given tree is null.

Since:

0.2.0 ~2021.05.30