Package io.virtdata.docsys.metafs.fs.renderfs.api.rendering

Class RenderingScope

java.lang.Object

io.virtdata.docsys.metafs.fs.renderfs.api.rendering.RenderingScope

All Implemented Interfaces:

Versioned

public class RenderingScope
extends java.lang.Object
implements Versioned

Constructor Summary

Constructors

Constructor	Description
RenderingScope(TemplateView templateView, ViewModel viewModel, TemplateCompiler compiler)
RenderingScope(java.nio.file.Path sourcePath, java.nio.file.Path targetPath, TemplateCompiler compiler)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDiagnosticSummary()
RenderedContent	getRendered()
TemplateView	getTemplate()
long	getVersion()	The version of an element can depend on more than one property internally.
ViewModel	getViewModel()
boolean	isValid()	If all the versioned parts of this elements are equal or higher version than all of the dependencies, then this element is valid.
java.lang.String	toString()
RenderingScope	wrap(RenderingScope innerScope)

Methods inherited from class java.lang.Object

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

Constructor Detail

RenderingScope

public RenderingScope(TemplateView templateView,
                      ViewModel viewModel,
                      TemplateCompiler compiler)

RenderingScope

public RenderingScope(java.nio.file.Path sourcePath,
                      java.nio.file.Path targetPath,
                      TemplateCompiler compiler)

Method Detail

getTemplate

public TemplateView getTemplate()

getViewModel

public ViewModel getViewModel()

getRendered

public RenderedContent getRendered()

wrap

public RenderingScope wrap(RenderingScope innerScope)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDiagnosticSummary

public java.lang.String getDiagnosticSummary()

getVersion

public long getVersion()

Description copied from interface: Versioned

The version of an element can depend on more than one property internally. Informally, the version of an element is the the lowest value of all the version properties of that element. This is a conservative back reference to the oldest contributing piece of data for that element, such that invalidation occurs based on the possibility that versions are not in sync, rather than any specific proof that they aren't.

Specified by:

getVersion in interface Versioned

Returns:

The version of the oldest part of a versioned element.

isValid

public boolean isValid()

Description copied from interface: Versioned

If all the versioned parts of this elements are equal or higher version than all of the dependencies, then this element is valid. Said differently, if the highest version of all dependencies is equal to or lower than the lowest version of all the parts, then this element is valid.

Specified by:

isValid in interface Versioned

Returns:

true, if this element is valid with respect to dependencies.