com.levigo.jadice.document.outline

Interface MutableOutlineNode<N extends MutableOutlineNode<N>>

Type Parameters:

N - the type of child node an instance uses

All Superinterfaces:

OutlineNode<N>, PropertiesProvider

All Known Subinterfaces:

MutableOutline<N>

All Known Implementing Classes:

Bookmark, DefaultOutline, DefaultOutlineNode

public interface MutableOutlineNode<N extends MutableOutlineNode<N>>
extends OutlineNode<N>

An extension interface for OutlineNodes which are mutable. Mutable outline nodes support the modification of their description, child list, instructions and properties.

Method Summary

Modifier and Type	Method and Description
List<N>	getChildren() Returns this node's direct children in a list which allows for modifications.
MutableOutline<N>	getOutline() Return the MutableOutline to which this node belongs.
Map<String,Object>	getProperties() Return a map of user properties.
void	setDescription(String description) Set the human-readable description for this node.
void	setInstructionChain(InstructionChain newChain) Replace this node's InstructionChain with the given one.

Methods inherited from interface com.levigo.jadice.document.outline.OutlineNode

getDescription, getInstructionChain, getParent

Method Detail

setInstructionChain

void setInstructionChain(InstructionChain newChain)

Replace this node's InstructionChain with the given one.

Parameters:

newChain - An InstructionChain holding the Instructions to be used by this node in the future.

setDescription

void setDescription(String description)

Set the human-readable description for this node. Defining the thread-safety for this modification is left to implementors.

Parameters:

description - the new description string

getOutline

MutableOutline<N> getOutline()

Return the MutableOutline to which this node belongs.

Specified by:

getOutline in interface OutlineNode<N extends MutableOutlineNode<N>>

Returns:

this node's MutableOutline

getChildren

List<N> getChildren()

Returns this node's direct children in a list which allows for modifications. Defining the thread-safety for such modifications is left to implementors.

Specified by:

getChildren in interface OutlineNode<N extends MutableOutlineNode<N>>

Returns:

the mutable list of nodes which are direct children of this node. No guarantees concerning thread-safety are given.

getProperties

Map<String,Object> getProperties()

Return a map of user properties. It may be used to store additional information which can serve to enrich the OutlineNode's presentation or in other ways further augment its data.

The map returned by this method is mutable. There are no guarantees regarding the thread-safety of the returned map, unless otherwise specified by implementors.

Specified by:

getProperties in interface OutlineNode<N extends MutableOutlineNode<N>>

Specified by:

getProperties in interface PropertiesProvider

Returns:

the mutable map of user properties