com.asakusafw.dmdl.util

Class AttributeUtil

java.lang.Object

com.asakusafw.dmdl.util.AttributeUtil

public final class AttributeUtil
extends Object

Utility methods for AstAttribute.

Since:

0.2.0

Version:

0.9.1

Method Summary

Modifier and Type	Method and Description
static boolean	checkFieldType(DmdlSemantics environment, PropertyDeclaration declaration, AstAttribute attribute, BasicTypeKind... types) Checks field type and report diagnostics.
static boolean	checkPresent(DmdlSemantics environment, AstNode targetNode, String targetLabel, String value) Checks which string is not null and report diagnostics.
static boolean	checkRange(DmdlSemantics environment, AstNode targetNode, String targetLabel, BigInteger value, Long minimum, Long maximum) Checks integer range and report diagnostics.
static Map<String,AstAttributeElement>	getElementMap(AstAttribute attribute) Extract the attributes into (name, element) pairs.
static boolean	hasFieldType(PropertyDeclaration declaration, BasicTypeKind... candidates) Returns whether or not the given field has one of the given types.
static List<Diagnostic>	reportInvalidElements(AstAttribute attribute, Collection<? extends AstAttributeElement> elements) Returns erroneous diagnostics for the undefined attribut elements.
static AstLiteral	takeLiteral(DmdlSemantics environment, AstAttribute attribute, Map<String,AstAttributeElement> elements, String elementName, LiteralKind literalKind, boolean mandatory) Removes AstAttributeElement from elements and extracts string value from it.
static String	takeString(DmdlSemantics environment, AstAttribute attribute, Map<String,AstAttributeElement> elements, String elementName, boolean mandatory) Removes AstAttributeElement from elements and extracts string value from it.

Methods inherited from class java.lang.Object

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

Method Detail

getElementMap

public static Map<String,AstAttributeElement> getElementMap(AstAttribute attribute)

Extract the attributes into (name, element) pairs.

The result map can be modified in user programs.

Parameters:

attribute - the target attribute

Returns:

the extracted pairs

Throws:

IllegalArgumentException - if some parameters were null

reportInvalidElements

public static List<Diagnostic> reportInvalidElements(AstAttribute attribute,
                                                     Collection<? extends AstAttributeElement> elements)

Returns erroneous diagnostics for the undefined attribut elements.

Parameters:

attribute - the elements' owner

elements - the invalid elements

Returns:

the corresponded diagnostics, or an empty list if the elements are empty

Throws:

IllegalArgumentException - if some parameters were null

takeLiteral

public static AstLiteral takeLiteral(DmdlSemantics environment,
                                     AstAttribute attribute,
                                     Map<String,AstAttributeElement> elements,
                                     String elementName,
                                     LiteralKind literalKind,
                                     boolean mandatory)

Removes AstAttributeElement from elements and extracts string value from it. If the element is not a string literal, this reports error into the environment.

Parameters:

environment - current environment

attribute - target attribute

elements - elements in target attribute

elementName - target element name

literalKind - target element kind

mandatory - true for mandatory element (report error if the element is not in map)

Returns:

the extracted literal, or null if is not defined or not a valid literal

Throws:

IllegalArgumentException - if some parameters were null

Since:

0.7.0

takeString

public static String takeString(DmdlSemantics environment,
                                AstAttribute attribute,
                                Map<String,AstAttributeElement> elements,
                                String elementName,
                                boolean mandatory)

Removes AstAttributeElement from elements and extracts string value from it. If the element is not a string literal, this reports error into the environment.

Parameters:

environment - current environment

attribute - target attribute

elements - elements in target attribute

elementName - target element name

mandatory - true for mandatory element (report error if the element is not in map)

Returns:

the extracted string, or null if is not defined or not a string

Throws:

IllegalArgumentException - if some parameters were null

hasFieldType

public static boolean hasFieldType(PropertyDeclaration declaration,
                                   BasicTypeKind... candidates)

Returns whether or not the given field has one of the given types.

Parameters:

declaration - the target property

candidates - the type candidates

Returns:

true if the property has a type, otherwise false

Since:

0.9.1

checkFieldType

public static boolean checkFieldType(DmdlSemantics environment,
                                     PropertyDeclaration declaration,
                                     AstAttribute attribute,
                                     BasicTypeKind... types)

Checks field type and report diagnostics.

Parameters:

environment - the current environment

declaration - the target declaration

attribute - the target attribute

types - expected types

Returns:

true if check is successfully completed, otherwise false

Since:

0.7.0

checkPresent

public static boolean checkPresent(DmdlSemantics environment,
                                   AstNode targetNode,
                                   String targetLabel,
                                   String value)

Checks which string is not null and report diagnostics.

Parameters:

environment - the current environment

targetNode - the target node

targetLabel - the target label

value - the target value

Returns:

true if check is successfully completed, otherwise false

Since:

0.7.0

checkRange

public static boolean checkRange(DmdlSemantics environment,
                                 AstNode targetNode,
                                 String targetLabel,
                                 BigInteger value,
                                 Long minimum,
                                 Long maximum)

Checks integer range and report diagnostics.

Parameters:

environment - the current environment

targetNode - the target node

targetLabel - the target label

value - the target value

minimum - the minimum value (inclusive), or null to unlimited

maximum - the maximum value (inclusive), or null to unlimited

Returns:

true if check is successfully completed, otherwise false

Since:

0.7.0