io.knotx.options

Class SnippetOptions

java.lang.Object

io.knotx.options.SnippetOptions

public class SnippetOptions
extends Object

Describes SnippetOptions Knot configuration

Constructor Summary

Constructors

Constructor and Description
SnippetOptions() Default constructor
SnippetOptions(io.vertx.core.json.JsonObject json) Create an settings from JSON
SnippetOptions(SnippetOptions other) Copy constructor

Method Summary

Modifier and Type	Method and Description
String	getDefaultFallback()
List<FallbackMetadata>	getFallbacks()
String	getFallbackTagName()
String	getParamsPrefix()
String	getTagName()
SnippetOptions	setDefaultFallback(String defaultFallback)
SnippetOptions	setFallbacks(List<FallbackMetadata> fallbacks)
SnippetOptions	setFallbackTagName(String fallbackTagName)
SnippetOptions	setParamsPrefix(String paramsPrefix) Sets Knot.x snippet parameters prefix.
SnippetOptions	setTagName(String tagName) Sets a Knot.x snippet HTML tag name.
io.vertx.core.json.JsonObject	toJson() Convert to JSON

Methods inherited from class java.lang.Object

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

Constructor Detail

SnippetOptions

public SnippetOptions()

Default constructor

SnippetOptions

public SnippetOptions(SnippetOptions other)

Copy constructor

Parameters:

other - the instance to copy

SnippetOptions

public SnippetOptions(io.vertx.core.json.JsonObject json)

Create an settings from JSON

Parameters:

json - the JSON

Method Detail

toJson

public io.vertx.core.json.JsonObject toJson()

Convert to JSON

Returns:

the JSON

getTagName

public String getTagName()

Returns:

a snippet tag name.

getFallbackTagName

public String getFallbackTagName()

getDefaultFallback

public String getDefaultFallback()

setDefaultFallback

public SnippetOptions setDefaultFallback(String defaultFallback)

setTagName

public SnippetOptions setTagName(String tagName)

Sets a Knot.x snippet HTML tag name. Default is 'script'

Parameters:

tagName - tag name

Returns:

a reference to this, so the API can be used fluently

setFallbackTagName

public SnippetOptions setFallbackTagName(String fallbackTagName)

getParamsPrefix

public String getParamsPrefix()

Returns:

a snippet params prefix

setParamsPrefix

public SnippetOptions setParamsPrefix(String paramsPrefix)

Sets Knot.x snippet parameters prefix. Default is 'data-knotx-'

Parameters:

paramsPrefix - prefix

Returns:

a reference to this, so the API can be used fluently

getFallbacks

public List<FallbackMetadata> getFallbacks()

setFallbacks

public SnippetOptions setFallbacks(List<FallbackMetadata> fallbacks)