io.github.fablabsmc.fablabs.impl.fiber.tree

Class IndexedNodeCollection

java.lang.Object

java.util.AbstractCollection<ConfigNode>

io.github.fablabsmc.fablabs.impl.fiber.tree.IndexedNodeCollection

All Implemented Interfaces:

NodeCollection, Iterable<ConfigNode>, Collection<ConfigNode>

public class IndexedNodeCollection
extends AbstractCollection<ConfigNode>
implements NodeCollection

Constructor Summary

Constructors

Constructor and Description
IndexedNodeCollection(ConfigBranch owner)

Method Summary

Modifier and Type	Method and Description
boolean	add(ConfigNode item) Attempts to introduce a new child to this collection.
boolean	add(ConfigNode item, boolean overwrite) Attempts to introduce a new child to this collection.
boolean	contains(Object o)
ConfigNode	getByName(String name) Tries to find a child in this collection by name.
Iterator<ConfigNode>	iterator()
boolean	remove(Object child) Removes a child from this collection.
ConfigNode	removeByName(String name) Attempts to remove an item from this collection by name.
int	size()
Spliterator<ConfigNode>	spliterator()

Methods inherited from class java.util.AbstractCollection

addAll, clear, containsAll, isEmpty, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

addAll, clear, containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, removeIf, retainAll, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

IndexedNodeCollection

public IndexedNodeCollection(@Nullable
                             ConfigBranch owner)

Method Detail

iterator

@Nonnull
public Iterator<ConfigNode> iterator()

Specified by:

iterator in interface Iterable<ConfigNode>

Specified by:

iterator in interface Collection<ConfigNode>

Specified by:

iterator in class AbstractCollection<ConfigNode>

spliterator

public Spliterator<ConfigNode> spliterator()

Specified by:

spliterator in interface Iterable<ConfigNode>

Specified by:

spliterator in interface Collection<ConfigNode>

add

public boolean add(ConfigNode item)
            throws DuplicateChildException

Description copied from interface: NodeCollection

Attempts to introduce a new child to this collection.

This method behaves as if add(node, false).

Specified by:

add in interface NodeCollection

Specified by:

add in interface Collection<ConfigNode>

Overrides:

add in class AbstractCollection<ConfigNode>

Parameters:

item - The child to add

Returns:

true (as specified by Collection.add(E))

Throws:

DuplicateChildException - if there was already a child by the same name

add

public boolean add(ConfigNode item,
                   boolean overwrite)
            throws DuplicateChildException

Description copied from interface: NodeCollection

Attempts to introduce a new child to this collection.

If this method returns normally, the child will be attached to this collection's owner.

Specified by:

add in interface NodeCollection

Parameters:

item - The child to add

overwrite - whether existing items with the same name should be overwritten

Returns:

true (as specified by Collection.add(E))

Throws:

DuplicateChildException - if there exists a child by the same name that was not overwritten

See Also:

ConfigNode.attachTo(ConfigBranch)

contains

public boolean contains(@Nullable
                        Object o)

Specified by:

contains in interface Collection<ConfigNode>

Overrides:

contains in class AbstractCollection<ConfigNode>

remove

public boolean remove(@Nullable
                      Object child)

Description copied from interface: NodeCollection

Removes a child from this collection.

When this method returns, the child will be detached from this collection's owner. If the given object is not contained within this collection, this method returns false with no side effects.

Specified by:

remove in interface NodeCollection

Specified by:

remove in interface Collection<ConfigNode>

Overrides:

remove in class AbstractCollection<ConfigNode>

Parameters:

child - the child to remove

Returns:

true if a node was detached as a result of this call

See Also:

ConfigNode.detach()

size

public int size()

Specified by:

size in interface Collection<ConfigNode>

Specified by:

size in class AbstractCollection<ConfigNode>

getByName

public ConfigNode getByName(String name)

Description copied from interface: NodeCollection

Tries to find a child in this collection by name. If a child is found, it will be returned.

Specified by:

getByName in interface NodeCollection

Parameters:

name - The name of the child to look for

Returns:

the child if found, otherwise null

removeByName

@Nullable
public ConfigNode removeByName(String name)

Description copied from interface: NodeCollection

Attempts to remove an item from this collection by name.

Specified by:

removeByName in interface NodeCollection

Parameters:

name - the name of the child that should be removed

Returns:

the child if removed, otherwise null