com.asakusafw.dmdl.directio.text

Class EscapeSettings

java.lang.Object

com.asakusafw.dmdl.directio.text.EscapeSettings

public class EscapeSettings
extends Object

Settings of character escape.

Since:

0.9.1

Constructor Summary

Constructors

Constructor and Description
EscapeSettings()

Method Summary

Modifier and Type	Method and Description
static EscapeSettings	consume(DmdlSemantics environment, AstAttribute attribute, Map<String,AstAttributeElement> elements) Consumes attribute elements about escape settings, and returns corresponding EscapeSettings.
Value<Character>	getCharacter() Returns the escape character.
Value<Boolean>	getEscapeLineSeparator() Returns whether or not line separators can be escaped.
MapValue<Character,Character>	getSequences() Returns the escape sequence map.
boolean	verify(DmdlSemantics environment, AstAttribute attribute) Verifies this settings.

Methods inherited from class java.lang.Object

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

Constructor Detail

EscapeSettings

public EscapeSettings()

Method Detail

getCharacter

public Value<Character> getCharacter()

Returns the escape character.

Returns:

the escape character

getSequences

public MapValue<Character,Character> getSequences()

Returns the escape sequence map.

Returns:

the escape sequence map

getEscapeLineSeparator

public Value<Boolean> getEscapeLineSeparator()

Returns whether or not line separators can be escaped.

Returns:

true if enabled, otherwise false

consume

public static EscapeSettings consume(DmdlSemantics environment,
                                     AstAttribute attribute,
                                     Map<String,AstAttributeElement> elements)

Consumes attribute elements about escape settings, and returns corresponding EscapeSettings.

Parameters:

environment - the current environment

attribute - the attribute

elements - the element map to be consumed

Returns:

corresponded EscapeSettings.

verify

public boolean verify(DmdlSemantics environment,
                      AstAttribute attribute)

Verifies this settings.

Parameters:

environment - the current environment

attribute - the original attribute

Returns:

true if the settings seems valid, otherwise false