public class SnippetContext extends Object
Constructor and Description |
---|
SnippetContext()
Creates a snippet context with default values for type (
Store.Type#PAGESTORE and release (false ). |
Modifier and Type | Method and Description |
---|---|
IDProvider |
getContextualElement()
Provide a FirstSpirit element to retrieve further information for snippet building.
|
FormData |
getMetaData()
Provide meta data to be used within a snippet definition.
|
Store.Type |
getStoreType()
Provide the store type to create a snippet for.
|
boolean |
isRelease()
Indicates, whether the snippet context is in release mode.
|
void |
setElement(IDProvider element)
Sets the element to be used as context information source for snippet building.
|
void |
setMetadata(FormData metadata)
Sets the meta data to be used for snippet building.
|
void |
setRelease(boolean release)
Sets the release type to be used for snippet building.
|
void |
setStoreType(Store.Type storeType)
Sets the store type to be used for snippet building.
|
public SnippetContext()
Store.Type#PAGESTORE
and release (false
).@NotNull public Store.Type getStoreType()
public void setStoreType(@NotNull Store.Type storeType)
storeType
- The Store.Type
to be used.NullPointerException
- If the given argument is null
.public boolean isRelease()
true
, if in release mode.public void setRelease(boolean release)
release
- true
, for release mode, false
, for current mode.@Nullable public FormData getMetaData()
null
.public void setMetadata(@Nullable FormData metadata)
metadata
- The meta data to be used.@Nullable public IDProvider getContextualElement()
null
.public void setElement(@Nullable IDProvider element)
element
- The element to be used.Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210