dev.dejvokep.boostedyaml.block

Class Block<T>

java.lang.Object

dev.dejvokep.boostedyaml.block.Block<T>

Type Parameters:

T - type of the value stored

Direct Known Subclasses:

Section, TerminatedBlock

public abstract class Block<T>
extends Object

Represents one YAML block, while storing its value and comments.

Constructor Summary

Constructors

Constructor and Description
Block(Block<?> previous, T value) Creates a block with the same comments as the provided previous block, with the given value.
Block(org.snakeyaml.engine.v2.nodes.Node keyNode, org.snakeyaml.engine.v2.nodes.Node valueNode, T value) Creates a block using the given parameters; while storing references to comments from the given nodes.
Block(T value) Creates a block with the given value, but no comments.

Method Summary

Modifier and Type	Method and Description
void	addComment(String comment) Adds the given comment to already existing comments (at NodeRole.KEY node at Comments.Position.BEFORE position).
void	addComments(List<String> comments) Adds the given comments to already existing comments (at NodeRole.KEY node at Comments.Position.BEFORE position).
List<String>	getComments() Returns comments (at NodeRole.KEY node at Comments.Position.BEFORE position).
T	getStoredValue() Returns the stored value.
protected void	init(org.snakeyaml.engine.v2.nodes.Node key, org.snakeyaml.engine.v2.nodes.Node value) Stores comments from the given nodes.
boolean	isIgnored() Returns if this block is ignored.
abstract boolean	isSection() Returns if this block represents a section.
void	removeComments() Removes all comments (at NodeRole.KEY node at Comments.Position.BEFORE position).
void	setComments(List<String> comments) Sets the given comments (at NodeRole.KEY node at Comments.Position.BEFORE position).
void	setIgnored(boolean ignored) Sets if to ignore this block.
void	setValue(T value) Sets a new value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Block

public Block(@Nullable
             org.snakeyaml.engine.v2.nodes.Node keyNode,
             @Nullable
             org.snakeyaml.engine.v2.nodes.Node valueNode,
             @Nullable
             T value)

Creates a block using the given parameters; while storing references to comments from the given nodes.

Parameters:

keyNode - node which represents the key to the block

valueNode - node which represents the value

value - the value to store

Block

public Block(@Nullable
             T value)

Creates a block with the given value, but no comments.

This constructor is only used by extending classes, where the comments (respective nodes) are unknown at the time of initialization. In such a scenario, it is needed to call init(Node, Node) afterwards.

Parameters:

value - the value to store

Block

public Block(@Nullable
             Block<?> previous,
             @Nullable
             T value)

Creates a block with the same comments as the provided previous block, with the given value. If given block is null, creates a block with no comments.

Parameters:

previous - the previous block to reference comments from

value - the value to store

Method Detail

init

protected void init(@Nullable
                    org.snakeyaml.engine.v2.nodes.Node key,
                    @Nullable
                    org.snakeyaml.engine.v2.nodes.Node value)

Stores comments from the given nodes. Only method which is able to mutate an instance of this class.

This method can also be referred to as the secondary constructor.

Parameters:

key - node which represents the key to the block

value - node which represents the value

setValue

public void setValue(T value)

Sets a new value.

Parameters:

value - the new value

getComments

@Nullable
public List<String> getComments()

Returns comments (at NodeRole.KEY node at Comments.Position.BEFORE position).

This method will return null or an empty List, indicating there are no comments.

Returns:

the comments

See Also:

Comments.get(Block, NodeRole, Comments.Position)

setComments

public void setComments(@Nullable
                        List<String> comments)

Sets the given comments (at NodeRole.KEY node at Comments.Position.BEFORE position).

To remove comments, use removeComments() instead. Alternatively, pass either null or an empty List as the parameter.

Parameters:

comments - the comments to set

See Also:

Comments.set(Block, NodeRole, Comments.Position, List)

removeComments

public void removeComments()

Removes all comments (at NodeRole.KEY node at Comments.Position.BEFORE position).

See Also:

Comments.remove(Block, NodeRole, Comments.Position)

addComments

public void addComments(@NotNull
                        List<String> comments)

Adds the given comments to already existing comments (at NodeRole.KEY node at Comments.Position.BEFORE position).

Parameters:

comments - the comments to add

See Also:

Comments.add(Block, NodeRole, Comments.Position, List)

addComment

public void addComment(@NotNull
                       String comment)

Adds the given comment to already existing comments (at NodeRole.KEY node at Comments.Position.BEFORE position).

Parameters:

comment - the comment to add

See Also:

Comments.add(Block, NodeRole, Comments.Position, CommentLine)

setIgnored

public void setIgnored(boolean ignored)

Sets if to ignore this block. Used only internally while updating.

Parameters:

ignored - if to ignore this block

isIgnored

public boolean isIgnored()

Returns if this block is ignored. Used only internally while updating.

Returns:

if this block is ignored

isSection

public abstract boolean isSection()

Returns if this block represents a section.

Returns:

if this block represents a section

getStoredValue

public T getStoredValue()

Returns the stored value.

For sections, this is a Map; for terminated blocks an Object.

Returns:

the stored value