senselogic.sitevision.api.node.builder

Interface TemporaryNodeBuilder

All Superinterfaces:

Builder<Node>

@Requireable(value="TemporaryNodeBuilder")
public interface TemporaryNodeBuilder
extends Builder<Node>

Builds volatile and short-lived nodes with primary node type sv:temporaryNode.

Important note! Temporary nodes are very volatile and short-lived. They have no parent, nor any children. A temporary node can never be looked up by its identifier and it should never be cached. Temporary nodes should only be used for temporary purposes, typically during a single rendering phase.

See Builder for a comprehensive example of how to work with builders.

An instance of the Sitevision class implementing this interface can be obtained via NodeFactoryUtil.getTemporaryNodeBuilder(). See NodeFactoryUtil for how to obtain an instance of the NodeFactoryUtil interface.

Since:

Sitevision 4.1.2

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
TemporaryNodeBuilder	addBooleanProperty(String aName, boolean aBoolean) Adds a boolean property to this builder.
TemporaryNodeBuilder	addCalendarProperty(String aName, Calendar aCalendar) Adds a Calendar property to this builder.
TemporaryNodeBuilder	addDateProperty(String aName, Date aDate) Adds a Date property to this builder.
TemporaryNodeBuilder	addDoubleProperty(String aName, double aDouble) Adds a double property to this builder.
TemporaryNodeBuilder	addIntProperty(String aName, int aInt) Adds a int property to this builder.
TemporaryNodeBuilder	addLongProperty(String aName, long aLong) Adds a long property to this builder.
TemporaryNodeBuilder	addNodeProperty(String aName, Node aNode) Adds a Node property to this builder.
TemporaryNodeBuilder	addNumericProperty(String aName, Number aNumber) Adds a numeric property (typically: Integer, Long or Double) to this builder.
TemporaryNodeBuilder	addStringProperty(String aName, String aString) Adds a String property to this builder.
Node	build() Creates a volatile and short-lived temporary node using current state (name and properties).
TemporaryNodeBuilder	clearAll() Clears the state of this builder.
TemporaryNodeBuilder	setName(String aNodeName) Sets the name of the temporary node that can be built by this builder.

Method Detail

setName

TemporaryNodeBuilder setName(String aNodeName)

Sets the name of the temporary node that can be built by this builder.

Parameters:

aNodeName - the name of the node

Returns:

this builder

addStringProperty

TemporaryNodeBuilder addStringProperty(String aName,
                                       String aString)

Adds a String property to this builder.

Note! Any previously added property with name aName will be overwritten with the value of this add operation.

Parameters:

aName - the name of the property

aString - the property value

Returns:

this builder

addDateProperty

TemporaryNodeBuilder addDateProperty(String aName,
                                     Date aDate)

Adds a Date property to this builder.

Note! Any previously added property with name aName will be overwritten with the value of this add operation.

Parameters:

aName - the name of the property

aDate - the property value

Returns:

this builder

addCalendarProperty

TemporaryNodeBuilder addCalendarProperty(String aName,
                                         Calendar aCalendar)

Adds a Calendar property to this builder.

Note! Any previously added property with name aName will be overwritten with the value of this add operation.

Parameters:

aName - the name of the property

aCalendar - the property value

Returns:

this builder

addBooleanProperty

TemporaryNodeBuilder addBooleanProperty(String aName,
                                        boolean aBoolean)

Adds a boolean property to this builder.

Note! Any previously added property with name aName will be overwritten with the value of this add operation.

Parameters:

aName - the name of the property

aBoolean - the property value

Returns:

this builder

addIntProperty

TemporaryNodeBuilder addIntProperty(String aName,
                                    int aInt)

Adds a int property to this builder.

Note! Any previously added property with name aName will be overwritten with the value of this add operation.

Parameters:

aName - the name of the property

aInt - the property value

Returns:

this builder

addLongProperty

TemporaryNodeBuilder addLongProperty(String aName,
                                     long aLong)

Adds a long property to this builder.

Note! Any previously added property with name aName will be overwritten with the value of this add operation.

Parameters:

aName - the name of the property

aLong - the property value

Returns:

this builder

addDoubleProperty

TemporaryNodeBuilder addDoubleProperty(String aName,
                                       double aDouble)

Adds a double property to this builder.

Note! Any previously added property with name aName will be overwritten with the value of this add operation.

Parameters:

aName - the name of the property

aDouble - the property value

Returns:

this builder

addNumericProperty

TemporaryNodeBuilder addNumericProperty(String aName,
                                        Number aNumber)

Adds a numeric property (typically: Integer, Long or Double) to this builder.

Note! Any previously added property with name aName will be overwritten with the value of this add operation.

Parameters:

aName - the name of the property

aNumber - the property value

Returns:

this builder

addNodeProperty

TemporaryNodeBuilder addNodeProperty(String aName,
                                     Node aNode)

Adds a Node property to this builder.

Note! Any previously added property with name aName will be overwritten with the value of this add operation.

Parameters:

aName - the name of the property

aNode - the property value

Returns:

this builder

clearAll

TemporaryNodeBuilder clearAll()

Clears the state of this builder.

This method will set the name to null and remove all properties.

Returns:

this builder

build

Node build()
    throws IllegalStateException

Creates a volatile and short-lived temporary node using current state (name and properties).

Specified by:

build in interface Builder<Node>

Returns:

a volatile and short-lived temporary node

Throws:

IllegalStateException - if no node name is set