com.asakusafw.operator.model

Class KeyMirror

java.lang.Object

com.asakusafw.operator.model.KeyMirror

public final class KeyMirror
extends Object

Represents a Key annotation model.

Since:

0.9.0

Version:

0.9.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeyMirror.Direction Represent ordering direction.
static class	KeyMirror.Group Represents grouping.
static class	KeyMirror.Order Represents ordering.

Method Summary

Modifier and Type	Method and Description
List<KeyMirror.Group>	getGroup() Returns the grouping key list.
List<KeyMirror.Order>	getOrder() Returns the ordering key list.
AnnotationMirror	getSource() Returns the source annotation.
static KeyMirror	parse(CompileEnvironment environment, AnnotationMirror source, Element annotationOwner, DataModelMirror contextType) Parses the target Key annotation.
String	toString()
List<String>	toTerms() Returns the property terms.

Methods inherited from class java.lang.Object

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

Method Detail

getSource

public AnnotationMirror getSource()

Returns the source annotation.

Returns:

the source

getGroup

public List<KeyMirror.Group> getGroup()

Returns the grouping key list.

Returns:

the group

getOrder

public List<KeyMirror.Order> getOrder()

Returns the ordering key list.

Returns:

the order

toTerms

public List<String> toTerms()

Returns the property terms. Each term must start with either = (grouping), + (ascendant order), or - (descendant order), and follow its property name.

Returns:

the property terms

Since:

0.9.1

parse

public static KeyMirror parse(CompileEnvironment environment,
                              AnnotationMirror source,
                              Element annotationOwner,
                              DataModelMirror contextType)

Parses the target Key annotation.

Parameters:

environment - current environment

source - the source annotation

annotationOwner - annotated target

contextType - target data model type

Returns:

the parsed result, or null if failed to parse

Throws:

IllegalArgumentException - if some parameters were null

toString

public String toString()

Overrides:

toString in class Object