de.vandermeer.skb.interfaces.antlr

Interface IsSTGroup

All Superinterfaces:

CategoryIs

public interface IsSTGroup
extends CategoryIs

Interface for objects that represent String Template Group (STG) objects (for which one can check chunks, get name, 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
Map<String,Set<String>>	getExpectedChunks() Returns the chunks expected to be defined in the STGroup object.
default String	getGroupName() Returns the name of the STGroup object (file name, source name, or group directory name).
STGroup	getSTGroup() Returns the STGroup object.
default Set<String>	validate() Validates the STGroup for expected chunks.

Method Detail

getSTGroup

STGroup getSTGroup()

Returns the STGroup object.

Returns:

STGroup object

getGroupName

default String getGroupName()

Returns the name of the STGroup object (file name, source name, or group directory name).

Returns:

STGroup name, null if getSTGroup() was null or if no name was found

getExpectedChunks

Map<String,Set<String>> getExpectedChunks()

Returns the chunks expected to be defined in the STGroup object.

Returns:

expected chunks as mapping from method name to set of method arguments

validate

default Set<String> validate()

Validates the STGroup for expected chunks.

Returns:

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