senselogic.sitevision.api.node.builder

Interface TemporaryFileNodeBuilder

All Superinterfaces:

Builder<Node>

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

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

The sole purpose of a sv:temporaryFile is to represent a java.io.File as javax.jcr.Node in order to support file-related operations in the API (e.g. FileUtil).

Important note! Temporary file nodes are very volatile and short-lived. They have no parent, nor any children. A temporary file node can never be looked up by its identifier and it should never be cached. Temporary file nodes should only be used for temporary purposes, typically during a single execution/render 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.getTemporaryFileNodeBuilder(). See NodeFactoryUtil for how to obtain an instance of the NodeFactoryUtil interface.

Since:

Sitevision 4.5.4

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
Node	build() Creates a volatile and short-lived temporary file node using current state.
TemporaryFileNodeBuilder	setFile(File aFile) Sets the file.
TemporaryFileNodeBuilder	setFileName(String aFileName) Sets the name of the file.

Method Detail

setFileName

TemporaryFileNodeBuilder setFileName(String aFileName)

Sets the name of the file.

The file name will also be used as the name of the Node that is built.

Parameters:

aFileName - the file name

Returns:

this builder

setFile

TemporaryFileNodeBuilder setFile(File aFile)

Sets the file.

Parameters:

aFile - the file

Returns:

this builder

build

Node build()
    throws IllegalStateException

Creates a volatile and short-lived temporary file node using current state.

Specified by:

build in interface Builder<Node>

Returns:

a volatile and short-lived temporary file node

Throws:

IllegalStateException - if no file is set or no file name is set