org.jamplate.model

Class Tree

java.lang.Object

org.jamplate.model.Tree

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<Tree>

public final class Tree
extends java.lang.Object
implements java.lang.Iterable<Tree>, java.io.Serializable

A tree is a point in a background structure of sketches that hold the variables of a runtime or a text component.
The background structure is working like magic and the user cannot interact directly with it.
A tree structure can only be modified throw the offer(Tree) method ony any tree in it. Any tree that get offered into a structure of another tree will be removed from its previous structure.
A structure cannot have any clashing sketches or sketches that does not fit their parent or sketches that breaks the order of their neighboring sketches in it and all the sketches in it will be organized implicitly.
The tree class is not thead safe and multiple threads modifying the same tree structure can make that structure corrupted. The corruption due to two thread modifying the same tree structure is undefined. Aside from that, two or more threads just reading the tree structure is totally fine. Also, one thread modifying a tree structure while the other threads just reading it will not corrupt the structure and will only confuse the other threads because random sketches will be moved around while those threads are reading.
Two identical trees in one structure is allowed only if the two trees has the same z-index. The tree with the higher z-index can fit inside the tree with the lower z-index.

Since:

0.2.0 ~2020.12.25

Version:

0.2.0

Author:

LSafer

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Tree(@NotNull Document document) Construct a new tree for the whole given document.
Tree(@NotNull Document document, int zIndex) Construct a new tree for the whole given document.
Tree(@NotNull Document document, @NotNull Reference reference) Construct a new tree with the given reference.
Tree(@NotNull Document document, @NotNull Reference reference, int zIndex) Construct a new tree with the given reference.
Tree(@NotNull Document document, @NotNull Reference reference, @NotNull Sketch sketch) Construct a new tree with the given reference and the given sketch.
Tree(@NotNull Document document, @NotNull Reference reference, @NotNull Sketch sketch, int zIndex) Construct a new tree with the given reference and the given sketch.
Tree(@NotNull Document document, @NotNull Sketch sketch) Construct a new tree for the whole given document.
Tree(@NotNull Document document, @NotNull Sketch sketch, int zIndex) Construct a new tree for the whole given document.

Method Summary

Modifier and Type	Method and Description
void	clear() Remove all the children of this tree without removing the structure between them.
@NotNull Document	document() Get the document of this tree.
boolean	equals(@Nullable java.lang.Object object)
@Nullable Tree	getChild() Get the first child tree of this tree.
@Nullable Tree	getNext() Get the tree after this tree.
@Nullable Tree	getParent() Get the tree containing this tree.
@Nullable Tree	getPrevious() Get the tree before this tree.
@NotNull Sketch	getSketch() Return the sketch assigned to this tree.
int	getZIndex() Return the Z-index of this tree.
int	hashCode()
@NotNull java.util.Iterator<Tree>	iterator()
void	offer(@NotNull Tree tree) Offer the given tree to the structure of this tree.
void	pop() Cleanly remove this tree from the structure it is on.
@NotNull Reference	reference() Get the reference of this tree.
void	remove() Remove this tree from its parent, the tree before it and the tree after it.
void	setSketch(@NotNull Sketch sketch) Set the sketch of this tree to be the given sketch.
@NotNull java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Tree

public Tree(@NotNull
            @NotNull Document document)

Construct a new tree for the whole given document.

Parameters:

document - the document the constructed tree is for.

Throws:

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

java.io.IOError - if any I/O error occurred while reading the given document to get its length.

DocumentNotFoundError - if the given document is not available for reading.

Since:

0.2.0 ~2021.05.17

Tree

@Contract(mutates="param2")
public Tree(@NotNull
                                         @NotNull Document document,
                                         @NotNull
                                         @NotNull Sketch sketch)

Construct a new tree for the whole given document.
After constructing this, the tree of the given sketch will be set to this.

Parameters:

document - the document the constructed tree is for.

sketch - the initial sketch set to this tree.

Throws:

java.lang.NullPointerException - if the given document or sketch is null.

java.lang.IllegalStateException - if the given sketch already has a tree.

java.io.IOError - if any I/O error occurred while reading the given document to get its length.

DocumentNotFoundError - if the given document is not available for reading.

Since:

0.2.0 ~2021.05.17

Tree

public Tree(@NotNull
            @NotNull Document document,
            @NotNull
            @NotNull Reference reference)

Construct a new tree with the given reference.

Parameters:

document - the document of the constructed tree.

reference - the reference of the constructed tree.

Throws:

java.lang.NullPointerException - if the given document or reference is null.

Since:

0.2.0 ~2021.05.15

Tree

@Contract(mutates="param3")
public Tree(@NotNull
                                         @NotNull Document document,
                                         @NotNull
                                         @NotNull Reference reference,
                                         @NotNull
                                         @NotNull Sketch sketch)

Construct a new tree with the given reference and the given sketch.
After constructing this, the tree of the given sketch will be set to this.

Parameters:

document - the document of the constructed tree.

reference - the reference of the contracted tree.

sketch - the initial sketch set to this tree.

Throws:

java.lang.NullPointerException - if the given document or reference or sketch is null.

java.lang.IllegalStateException - if the given sketch already has a tree.

Since:

0.2.0 ~2021.05.15

Tree

public Tree(@NotNull
            @NotNull Document document,
            int zIndex)

Construct a new tree for the whole given document.

Parameters:

document - the document the constructed tree is for.

zIndex - the z-index for the constructed tree.

Throws:

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

java.io.IOError - if any I/O error occurred while reading the given document to get its length.

DocumentNotFoundError - if the given document is not available for reading.

Since:

0.2.0 ~2021.05.17

Tree

@Contract(mutates="param2")
public Tree(@NotNull
                                         @NotNull Document document,
                                         @NotNull
                                         @NotNull Sketch sketch,
                                         int zIndex)

Construct a new tree for the whole given document.
After constructing this, the tree of the given sketch will be set to this.

Parameters:

document - the document the constructed tree is for.

sketch - the initial sketch set to this tree.

zIndex - the z-index for the constructed tree.

Throws:

java.lang.NullPointerException - if the given document or sketch is null.

java.lang.IllegalStateException - if the given sketch already has a tree.

java.io.IOError - if any I/O error occurred while reading the given document to get its length.

DocumentNotFoundError - if the given document is not available for reading.

Since:

0.2.0 ~2021.05.17

Tree

public Tree(@NotNull
            @NotNull Document document,
            @NotNull
            @NotNull Reference reference,
            int zIndex)

Construct a new tree with the given reference.

Parameters:

document - the document of the constructed tree.

reference - the reference of the constructed tree.

zIndex - the z-index for the constructed tree.

Throws:

java.lang.NullPointerException - if the given document or reference is null.

Since:

0.2.0 ~2021.05.15

Tree

@Contract(mutates="param3")
public Tree(@NotNull
                                         @NotNull Document document,
                                         @NotNull
                                         @NotNull Reference reference,
                                         @NotNull
                                         @NotNull Sketch sketch,
                                         int zIndex)

Construct a new tree with the given reference and the given sketch.
After constructing this, the tree of the given sketch will be set to this.

Parameters:

document - the document of the constructed tree.

reference - the reference of the contracted tree.

sketch - the initial sketch set to this tree.

zIndex - the z-index for the constructed tree.

Throws:

java.lang.NullPointerException - if the given document or reference or sketch is null.

java.lang.IllegalStateException - if the given sketch already has a tree.

Since:

0.2.0 ~2021.05.15

Method Detail

equals

@Contract(value="null->false",
          pure=true)
public boolean equals(@Nullable
                                                                            @Nullable java.lang.Object object)

Overrides:

equals in class java.lang.Object

hashCode

@Contract(pure=true)
public int hashCode()

Overrides:

hashCode in class java.lang.Object

iterator

@NotNull
 @Contract(value="->new",
          pure=true)
public @NotNull java.util.Iterator<Tree> iterator()

Specified by:

iterator in interface java.lang.Iterable<Tree>

Since:

0.2.0 ~2021.05.17

toString

@NotNull
 @Contract(pure=true)
public @NotNull java.lang.String toString()

Overrides:

toString in class java.lang.Object

clear

@Contract(mutates="this")
public void clear()

Remove all the children of this tree without removing the structure between them.
This method will unlink the link between this tree and its first child. With that, the first child and the other children will have no parent. But, the links between the children will not be broken nor the links between the children and the grand children.

Since:

0.2.0 ~2021.05.17

document

@NotNull
 @Contract(pure=true)
public @NotNull Document document()

Get the document of this tree.

Returns:

the document of this tree.

Since:

0.2.0 ~2021.05.17

getChild

@Nullable
 @Contract(pure=true)
public @Nullable Tree getChild()

Get the first child tree of this tree.

Returns:

the first tree in this tree. Or null if this tree has no children.

Since:

0.2.0 ~2021.05.17

getNext

@Nullable
 @Contract(pure=true)
public @Nullable Tree getNext()

Get the tree after this tree.

Returns:

the tree after this tree. Or null if this tree is the last tree.

Since:

0.2.0 ~2021.05.17

getParent

@Nullable
 @Contract(pure=true)
public @Nullable Tree getParent()

Get the tree containing this tree.

Returns:

the parent tree of this tree. Or null if this tree has no parent.

Since:

0.2.0 ~2021.05.17

getPrevious

@Nullable
 @Contract(pure=true)
public @Nullable Tree getPrevious()

Get the tree before this tree.

Returns:

the tree before this tree. Or null if this tree is the first tree.

Since:

0.2.0 ~2021.05.17

getSketch

@NotNull
 @Contract(pure=true)
public @NotNull Sketch getSketch()

Return the sketch assigned to this tree.

Returns:

the sketch of this tree.

Since:

0.2.0 ~2021.05.17

getZIndex

@Contract(pure=true)
public int getZIndex()

Return the Z-index of this tree.

Returns:

the z index of this tree.

Since:

0.2.0 ~2021.05.30

offer

@Contract(mutates="this,param")
public void offer(@NotNull
                                                   @NotNull Tree tree)

Offer the given tree to the structure of this tree. The given tree will be removed from its structure then put to the proper place in the structure of this tree.
If failed to insert the given tree because of an IllegalTreeException, then the method will exit without anything changed.

Parameters:

tree - the tree to be added.

Throws:

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

TreeOutOfBoundsException - if the given tree does not fit in the parent of this tree.

TreeTakeoverException - if the given tree has the same range as a tree in the structure of this tree.

TreeClashException - if the given tree clashes with another tree in the structure of this tree.

Since:

0.2.0 ~2021.05.14

pop

@Contract(mutates="this")
public void pop()

Cleanly remove this tree from the structure it is on.

Since:

0.2.0 ~2021.05.14

reference

@NotNull
 @Contract(pure=true)
public @NotNull Reference reference()

Get the reference of this tree.

Returns:

the reference of this tree.

Since:

0.2.0 ~2021.05.14

remove

@Contract(mutates="this")
public void remove()

Remove this tree from its parent, the tree before it and the tree after it.

Since:

0.2.0 ~2021.05.17

setSketch

@Contract(mutates="this")
public void setSketch(@NotNull
                                                 @NotNull Sketch sketch)

Set the sketch of this tree to be the given sketch. The previous tree of the given sketch will have a new sketch set to it.

Parameters:

sketch - the sketch to be set.

Since:

0.2.0 ~2021.05.17