de.vandermeer.skb.interfaces.antlr

Interface IsST

All Superinterfaces:

CategoryDoes, CategoryIs, DoesRender

public interface IsST
extends DoesRender, CategoryIs

Interface for objects that represent String Template (ST) objects (for which one can check chunks etc).

Since:

v0.0.1

Version:

v0.0.1 build 170404 (04-Apr-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Method Summary

Modifier and Type	Method and Description
static IsST	create(ST st) Creates a new IsST object.
static IsST	create(ST st, Set<String> expectedArguments) Creates a new IsST object.
Set<String>	getExpectedArguments() Returns the arguments expected to be defined in the ST object.
ST	getST() Returns the ST object.
default String	render() Renders an object for (text) output.
default Set<String>	validate() Validates the ST for expected arguments.

Method Detail

getST

ST getST()

Returns the ST object.

Returns:

ST object

render

default String render()

Description copied from interface: DoesRender

Renders an object for (text) output.

Specified by:

render in interface DoesRender

Returns:

rendered object, should not be null

getExpectedArguments

Set<String> getExpectedArguments()

Returns the arguments expected to be defined in the ST object.

Returns:

expected arguments as set of argument names

validate

default Set<String> validate()

Validates the ST for expected arguments.

Returns:

a set of error messages, empty if no errors found, null if no expected arguments where set or no ST was set

create

static IsST create(ST st)

Creates a new IsST object.

Parameters:

st - the contained ST object

Returns:

new IsST object

Throws:

NullPointerException - if st was null

create

static IsST create(ST st,
                   Set<String> expectedArguments)

Creates a new IsST object.

Parameters:

st - the contained ST object

expectedArguments - set of expected arguments for the ST

Returns:

new IsST object

Throws:

NullPointerException - if st was null or the expected arguments was not null and contained null elements