tools.gsf.navigation.siteplan

Class AbstractAssetNode<N extends AssetNode<N> & ConfigurableNode<N>>

java.lang.Object

tools.gsf.navigation.siteplan.AbstractAssetNode<N>

All Implemented Interfaces:

Serializable, AssetNode<N>, ConfigurableNode<N>, Node<N>

public abstract class AbstractAssetNode<N extends AssetNode<N> & ConfigurableNode<N>>
extends Object
implements AssetNode<N>, ConfigurableNode<N>

Simple node, representing an asset, that can be populated with asset data. It is up to the concrete class extending this base class to decide what data to expose and how. This base class just deals with the annoying stuff required by most (all?) AssetNode implementations.

Since:

2017-03-02.

Author:

Freddy Villalba

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<N>	children
protected com.fatwire.assetapi.data.AssetId	id
protected N	parent

Constructor Summary

Constructors

Constructor and Description
AbstractAssetNode(com.fatwire.assetapi.data.AssetId assetId)

Method Summary

Modifier and Type	Method and Description
void	addChild(N node) Add a child at the end of this node's list of children.
boolean	equals(Object o)
List<N>	getChildren() Return this node's children, if any, in ranked order
com.fatwire.assetapi.data.AssetId	getId()
N	getParent() Get the parent node
List<N>	getSiblings() Get the siblings of this node.
int	hashCode()
boolean	removeChild(N child) Breaks the relationship between this node and the specified child, meaning: - This node is not the parent of the specified child anymore.
void	removeChildren() Breaks the relationship between this node and all of its children, meaning: - This node is not the parent of any of its children anymore.
void	setParent(N parent) Can only be called once per instance.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected com.fatwire.assetapi.data.AssetId id

parent

protected N extends AssetNode<N> & ConfigurableNode<N> parent

children

protected ArrayList<N extends AssetNode<N> & ConfigurableNode<N>> children

Constructor Detail

AbstractAssetNode

public AbstractAssetNode(com.fatwire.assetapi.data.AssetId assetId)

Method Detail

getId

public com.fatwire.assetapi.data.AssetId getId()

Specified by:

getId in interface AssetNode<N extends AssetNode<N> & ConfigurableNode<N>>

addChild

public void addChild(N node)

Description copied from interface: ConfigurableNode

Add a child at the end of this node's list of children. If children must be ordered in any particular way, it's the caller's responsibility to add them in the right order. This method must be invoked BEFORE setParent. Calling it AFTER setParent will throw a runtime exception.

Specified by:

addChild in interface ConfigurableNode<N extends AssetNode<N> & ConfigurableNode<N>>

setParent

public void setParent(N parent)

Description copied from interface: ConfigurableNode

Can only be called once per instance. Otherwise, a runtime exception will be thrown.

Specified by:

setParent in interface ConfigurableNode<N extends AssetNode<N> & ConfigurableNode<N>>

removeChildren

public void removeChildren()

Description copied from interface: ConfigurableNode

Breaks the relationship between this node and all of its children, meaning: - This node is not the parent of any of its children anymore. - The removed nodes are not this node's children anymore.

Specified by:

removeChildren in interface ConfigurableNode<N extends AssetNode<N> & ConfigurableNode<N>>

removeChild

public boolean removeChild(N child)

Description copied from interface: ConfigurableNode

Breaks the relationship between this node and the specified child, meaning: - This node is not the parent of the specified child anymore. - The removed node is not this node's child anymore. The method returns true if the specified child was removed, false otherwise.

Specified by:

removeChild in interface ConfigurableNode<N extends AssetNode<N> & ConfigurableNode<N>>

Parameters:

child - The child node we want to remove

Returns:

true if the node was removed, false otherwise

getParent

public N getParent()

Description copied from interface: Node

Get the parent node

Specified by:

getParent in interface Node<N extends AssetNode<N> & ConfigurableNode<N>>

Returns:

parent node

getSiblings

public List<N> getSiblings()

Description copied from interface: Node

Get the siblings of this node. All siblings are returned in ranked order, including this node.

Specified by:

getSiblings in interface Node<N extends AssetNode<N> & ConfigurableNode<N>>

Returns:

sibling nodes

getChildren

public List<N> getChildren()

Description copied from interface: Node

Return this node's children, if any, in ranked order

Specified by:

getChildren in interface Node<N extends AssetNode<N> & ConfigurableNode<N>>

Returns:

this node's children, never null.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object