io.knotx.assembler

Class FragmentAssemblerOptions

java.lang.Object

io.knotx.assembler.FragmentAssemblerOptions

public class FragmentAssemblerOptions
extends Object

Describes FragmentAssembler Knot configuration

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getAddress()
SnippetOptions	getSnippetOptions()
UnprocessedFragmentStrategy	getUnprocessedStrategy()
FragmentAssemblerOptions	setAddress(String address) Set the EB address of the verticle
FragmentAssemblerOptions	setSnippetOptions(SnippetOptions snippetOptions) Sets snippet options (e.g.
FragmentAssemblerOptions	setUnprocessedStrategy(UnprocessedFragmentStrategy unprocessedStrategy) Set the strategy how to assembly markup with snippets that were not processed by any Knot.
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

FragmentAssemblerOptions

public FragmentAssemblerOptions()

Default constructor

FragmentAssemblerOptions

public FragmentAssemblerOptions(FragmentAssemblerOptions other)

Copy constructor

Parameters:

other - the instance to copy

FragmentAssemblerOptions

public FragmentAssemblerOptions(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

getAddress

public String getAddress()

Returns:

EB address of the verticle

setAddress

public FragmentAssemblerOptions setAddress(String address)

Set the EB address of the verticle

Parameters:

address - EB address

Returns:

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

getUnprocessedStrategy

public UnprocessedFragmentStrategy getUnprocessedStrategy()

Returns:

Unprocessed snippets strategy name

setUnprocessedStrategy

public FragmentAssemblerOptions setUnprocessedStrategy(UnprocessedFragmentStrategy unprocessedStrategy)

Set the strategy how to assembly markup with snippets that were not processed by any Knot. Allowed values are:

• AS_IS - Keep the whole unprocessed snippet as is
• UNWRAP - Remove the wrapping script tag from the snippet
• IGNORE - Remove snippet from the markup

If not set, a default value is UNWRAP

Parameters:

unprocessedStrategy - a strategy enum

Returns:

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

getSnippetOptions

public SnippetOptions getSnippetOptions()

Returns:

a snippet configuration

setSnippetOptions

public FragmentAssemblerOptions setSnippetOptions(SnippetOptions snippetOptions)

Sets snippet options (e.g. with tag and data prefix names).

Parameters:

snippetOptions - options

Returns:

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