org.nuxeo.ecm.platform.rendering.impl

Class DefaultRenderingResult

java.lang.Object

org.nuxeo.ecm.platform.rendering.impl.DefaultRenderingResult

All Implemented Interfaces:

Serializable, RenderingResult, Adaptable

public abstract class DefaultRenderingResult
extends Object
implements RenderingResult

Author:

Bogdan Stefanescu

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	formatName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultRenderingResult(String formatName) Constructor taking a rendering result name as argument.

Method Summary

Modifier and Type	Method and Description
<E> E	getAdapter(Class<E> adapter) Returns an object which is an instance of the given class associated with this object.
String	getFormatName() Gets the format name of the result.
abstract Object	getOutcome() Gets the rendering result object.
InputStream	getStream() Gets the rendering result as a stream.

Methods inherited from class java.lang.Object

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

Field Detail

formatName

protected final String formatName

Constructor Detail

DefaultRenderingResult

protected DefaultRenderingResult(String formatName)

Constructor taking a rendering result name as argument.

Parameters:

formatName -

Method Detail

getFormatName

public String getFormatName()

Description copied from interface: RenderingResult

Gets the format name of the result. This can be use to identify the type of the result. The format name can be a mime type or any application-defined format.

Specified by:

getFormatName in interface RenderingResult

Returns:

name of the engine that created it

getOutcome

public abstract Object getOutcome()

Description copied from interface: RenderingResult

Gets the rendering result object.

Specified by:

getOutcome in interface RenderingResult

Returns:

the rendering result. must never be null

getStream

public InputStream getStream()

Description copied from interface: RenderingResult

Gets the rendering result as a stream.

Specified by:

getStream in interface RenderingResult

Returns:

the stream or null if the outcome cannot be expressed as a stream

getAdapter

public <E> E getAdapter(Class<E> adapter)

Description copied from interface: Adaptable

Returns an object which is an instance of the given class associated with this object. Returns null if no such object can be found.

Specified by:

getAdapter in interface Adaptable

Parameters:

adapter - the adapter class to look up

Returns:

a object castable to the given class, or null if this object does not have an adapter for the given class