org.jamplate.model

Class Sketch

java.lang.Object

org.jamplate.model.Sketch

All Implemented Interfaces:

java.io.Serializable

public class Sketch
extends java.lang.Object
implements java.io.Serializable

A class that holds the thoughts about a syntax or runtime component.

Since:

0.2.0 ~2021.05.17

Version:

0.2.0

Author:

LSafer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected @NotNull cufy.util.Node<Sketch>	components A node relating to the components of this sketch.
protected @NotNull java.lang.String	kind The kind name of this sketch.
protected @NotNull java.util.Map<java.lang.String,java.lang.Object>	meta The additional meta-data of this sketch.
protected @NotNull java.lang.String	name The current name of this sketch.
protected @Nullable Tree	tree The tree this sketch is from.

Constructor Summary

Constructors

Constructor and Description
Sketch() Construct a new sketch.
Sketch(@NotNull java.lang.String kind) Construct a new sketch.
Sketch(@NotNull java.lang.String name, @NotNull java.lang.String kind) Construct a new sketch.
Sketch(@NotNull Tree tree) Construct a new sketch that references the given tree as its tree.
Sketch(@NotNull Tree tree, @NotNull java.lang.String kind) Construct a new sketch that references the given tree as its tree.
Sketch(@NotNull Tree tree, @NotNull java.lang.String name, @NotNull java.lang.String kind) Construct a new sketch that references the given tree as its tree.

Method Summary

Modifier and Type	Method and Description
static cufy.util.Node.Key	component(java.lang.String name) Return the component key with the given name.
@NotNull Sketch	get(cufy.util.Node.Key key) Return the component of this sketch with the given key.
@NotNull java.lang.String	getKind() Return the kind of this sketch.
@NotNull java.util.Map<java.lang.String,java.lang.Object>	getMeta() Get the meta-data map of this sketch.
@NotNull java.lang.String	getName() Get the name of this tree.
@Nullable Tree	getTree() Return the tree of this sketch.
@NotNull Sketch	replace(cufy.util.Node.Key key) Replace the component of this sketch with the given key with another sketch.
@NotNull Sketch	setKind(@NotNull java.lang.String kind) Set the kind of this sketch to be the given kind.
@NotNull Sketch	setName(@NotNull java.lang.String name) Set the name of this sketch to be the given name.
Sketch	setTree(@NotNull Tree tree) Set the tree this sketch is from to be the given tree.
@NotNull java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

components

@NotNull
protected final @NotNull cufy.util.Node<Sketch> components

A node relating to the components of this sketch.

Since:

0.2.0 ~2021.05.25

meta

@NotNull
protected final @NotNull java.util.Map<java.lang.String,java.lang.Object> meta

The additional meta-data of this sketch.

Since:

0.2.0 ~2021.05.21

kind

@NotNull
protected @NotNull java.lang.String kind

The kind name of this sketch.

Since:

0.2.0 ~2021.05.17

name

@NotNull
protected @NotNull java.lang.String name

The current name of this sketch.

Since:

0.2.0 ~2021.05.14

tree

@Nullable
protected @Nullable Tree tree

The tree this sketch is from.

Since:

0.2.0 ~2021.05.17

Constructor Detail

Sketch

public Sketch()

Construct a new sketch.

Since:

0.2.0 ~2021.05.17

Sketch

public Sketch(@NotNull
              @NotNull java.lang.String kind)

Construct a new sketch.

Parameters:

kind - the initial kind of the constructed sketch.

Throws:

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

Since:

0.2.0 ~2021.05.30

Sketch

public Sketch(@NotNull
              @NotNull java.lang.String name,
              @NotNull
              @NotNull java.lang.String kind)

Construct a new sketch.

Parameters:

name - the initial name of the constructed sketch.

kind - the initial kind of the constructed sketch.

Throws:

java.lang.NullPointerException - if the given name or kind is null.

Since:

0.2.0 ~2021.05.30

Sketch

public Sketch(@NotNull
              @NotNull Tree tree)

Construct a new sketch that references the given tree as its tree.

Parameters:

tree - the tree the constructed sketch will be pointing to.

Throws:

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

Since:

0.2.0 ~2021.05.17

Sketch

public Sketch(@NotNull
              @NotNull Tree tree,
              @NotNull
              @NotNull java.lang.String kind)

Construct a new sketch that references the given tree as its tree.

Parameters:

tree - the tree the constructed sketch will be pointing to.

kind - the initial kind of the constructed sketch.

Throws:

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

Since:

0.2.0 ~2021.05.17

Sketch

public Sketch(@NotNull
              @NotNull Tree tree,
              @NotNull
              @NotNull java.lang.String name,
              @NotNull
              @NotNull java.lang.String kind)

Construct a new sketch that references the given tree as its tree.

Parameters:

tree - the tree the constructed sketch will be pointing to.

name - the initial name of the constructed sketch.

kind - the initial kind of the constructed sketch.

Throws:

java.lang.NullPointerException - if the given tree or name or kind is null.

Since:

0.2.0 ~2021.05.17

Method Detail

component

@NotNull
 @Contract(pure=true)
public static cufy.util.Node.Key component(java.lang.String name)

Return the component key with the given name.

Parameters:

name - the name of the component.

Returns:

the component key.

Throws:

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

Since:

0.2.0 ~2021.05.30

toString

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

Overrides:

toString in class java.lang.Object

get

@NotNull
 @Contract(pure=true)
public @NotNull Sketch get(@NotNull
                                                            cufy.util.Node.Key key)

Return the component of this sketch with the given key.

Parameters:

key - the key of the component.

Returns:

the component with the given key.

Throws:

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

Since:

0.2.0 ~2021.05.25

getKind

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

Return the kind of this sketch.

Returns:

the kind of this sketch.

Since:

0.2.0 ~2021.05.17

getMeta

@NotNull
 @Contract(pure=true)
public @NotNull java.util.Map<java.lang.String,java.lang.Object> getMeta()

Get the meta-data map of this sketch.
By default, the returned map will be a modifiable checked map. Unless, the class of this said otherwise.

Returns:

the meta-data map of this.

Since:

0.2.0 ~2021.05.21

getName

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

Get the name of this tree.

Returns:

the name of this tree.

Since:

0.2.0 ~2021.05.14

getTree

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

Return the tree of this sketch.

Returns:

the tree of this sketch.

Since:

0.2.0 ~2021.05.17

replace

@NotNull
 @Contract(mutates="this")
public @NotNull Sketch replace(@NotNull
                                                                     cufy.util.Node.Key key)

Replace the component of this sketch with the given key with another sketch.

Parameters:

key - the key of the component.

Returns:

the replacement sketch.

Throws:

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

Since:

0.2.0 ~2021.06.01

setKind

@NotNull
 @Contract(value="_->this",
          mutates="this")
public @NotNull Sketch setKind(@NotNull
                                                                                                 @NotNull java.lang.String kind)

Set the kind of this sketch to be the given kind.

Parameters:

kind - the kind of this sketch.

Returns:

this.

Since:

0.2.0 ~2021.05.17

setName

@NotNull
 @Contract(value="_->this",
          mutates="this")
public @NotNull Sketch setName(@NotNull
                                                                                                 @NotNull java.lang.String name)

Set the name of this sketch to be the given name.

Parameters:

name - the name of this sketch.

Returns:

this.

Since:

0.2.0 ~2021.05.17

setTree

@Contract(value="_->this",
          mutates="this")
public Sketch setTree(@NotNull
                                                                             @NotNull Tree tree)

Set the tree this sketch is from to be the given tree.

Parameters:

tree - the tree to be set.

Returns:

this.

Throws:

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

java.lang.IllegalStateException - if this sketch already have a tree set.

Since:

0.2.0 ~2021.05.17