com.asakusafw.dmdl.directio.text

Class TextFieldTrait

java.lang.Object

com.asakusafw.dmdl.directio.text.TextFieldTrait

All Implemented Interfaces:

Element, Trait<TextFieldTrait>

public class TextFieldTrait
extends Object
implements Trait<TextFieldTrait>

Attributes of formatted text fields.

Since:

0.9.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextFieldTrait.Kind The field kind.

Constructor Summary

Constructors

Constructor and Description
TextFieldTrait(AstAttribute attribute, String name, TextFieldSettings settings) Creates a new instance.
TextFieldTrait(AstAttribute attribute, TextFieldTrait.Kind kind) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
static Optional<TextFieldTrait>	find(PropertyDeclaration property) Returns the trait for the property.
static TextFieldTrait	get(PropertyDeclaration property) Returns the trait for the property.
TextFieldTrait.Kind	getKind() Returns the field kind.
static TextFieldTrait.Kind	getKind(PropertyDeclaration property) Returns the field kind of the property.
String	getName() Returns the field name.
static String	getName(PropertyDeclaration property) Returns the field name of the property.
AstNode	getOriginalAst() Returns the corresponded syntactic element of this.
TextFieldSettings	getSettings() Returns the settings.
static TextFieldSettings	getSettings(PropertyDeclaration property) Returns the field settings of the property.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextFieldTrait

public TextFieldTrait(AstAttribute attribute,
                      TextFieldTrait.Kind kind)

Creates a new instance.

Parameters:

attribute - the original attribute

kind - the field kind

Throws:

IllegalArgumentException - if some parameters were null

TextFieldTrait

public TextFieldTrait(AstAttribute attribute,
                      String name,
                      TextFieldSettings settings)

Creates a new instance.

Parameters:

attribute - the original attribute

name - the explicit field name (nullable)

settings - the field settings

Throws:

IllegalArgumentException - if some parameters were null

Method Detail

getOriginalAst

public AstNode getOriginalAst()

Description copied from interface: Element

Returns the corresponded syntactic element of this.

Specified by:

getOriginalAst in interface Element

Returns:

the corresponded syntactic element, or null if unknown

find

public static Optional<TextFieldTrait> find(PropertyDeclaration property)

Returns the trait for the property.

Parameters:

property - the property

Returns:

the trait, or empty if it is not defined

get

public static TextFieldTrait get(PropertyDeclaration property)

Returns the trait for the property.

Parameters:

property - the property

Returns:

the trait

getKind

public static TextFieldTrait.Kind getKind(PropertyDeclaration property)

Returns the field kind of the property. If the field kind is not declared explicitly in the property, this returns the default kind.

Parameters:

property - target property

Returns:

the field kind

getName

public static String getName(PropertyDeclaration property)

Returns the field name of the property. If the field name is not declared explicitly in the property, this returns the property name.

Parameters:

property - target property

Returns:

the field name

getSettings

public static TextFieldSettings getSettings(PropertyDeclaration property)

Returns the field settings of the property. If the field settings is not declared explicitly in the property, this returns the property settings.

Parameters:

property - target property

Returns:

the field settings

getKind

public TextFieldTrait.Kind getKind()

Returns the field kind.

Returns:

the kind

getName

public String getName()

Returns the field name.

Returns:

the name

getSettings

public TextFieldSettings getSettings()

Returns the settings.

Returns:

the settings