org.paninij.proc.util

Class PaniniModel

java.lang.Object

org.paninij.proc.util.PaniniModel

public class PaniniModel
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CAPSULE_CORE_SUFFIX
static java.lang.String	CAPSULE_TEST_CORE_SUFFIX
static java.lang.String	CAPSULE_TEST_SUFFIX
static java.lang.String	DEFAULT_DUCK_PACKAGE
static java.lang.String	DEFAULT_FUTURE_PACKAGE
static java.lang.String	DEFAULT_MESSAGE_PACKAGE
static java.lang.String	SIGNATURE_CORE_SUFFIX
static java.lang.String[]	specialPaniniDecls

Constructor Summary

Constructors

Constructor and Description
PaniniModel()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	buildExportMethodDecl(javax.annotation.processing.ProcessingEnvironment context, javax.lang.model.element.TypeElement core) Inspects the given capsule core, finds the design declaration on it, then returns a String representation of a `imports()` method declaration.
static javax.lang.model.element.ExecutableElement	getCapsuleDesignDecl(javax.lang.model.element.TypeElement core) Returns the `ExecutableElement` representing the given capsule core design declaration, or returns `null` if there is no such declaration.
static java.util.List<javax.lang.model.element.VariableElement>	getCapsuleFieldDecls(javax.annotation.processing.ProcessingEnvironment context, javax.lang.model.element.TypeElement core)
static java.util.List<javax.lang.model.element.VariableElement>	getImportFieldDecls(javax.annotation.processing.ProcessingEnvironment context, javax.lang.model.element.TypeElement core)
static java.util.List<javax.lang.model.element.VariableElement>	getLocalFieldDecls(javax.annotation.processing.ProcessingEnvironment context, javax.lang.model.element.TypeElement core)
static java.util.List<javax.lang.model.element.ExecutableElement>	getProcedures(javax.lang.model.element.TypeElement core) Returns a list of all of the procedures (represented as `ExcecutableElement`s) defined on the given `core`.
static java.util.List<javax.lang.model.element.VariableElement>	getStateFieldDecls(javax.annotation.processing.ProcessingEnvironment context, javax.lang.model.element.TypeElement core)
static boolean	hasCapsuleDesignDecl(javax.lang.model.element.TypeElement core) Returns `true` if and only if the given capsule core has a design declaration.
static boolean	hasCapsuleFieldDecls(javax.annotation.processing.ProcessingEnvironment context, javax.lang.model.element.TypeElement core)
static boolean	hasImportFieldDecls(javax.annotation.processing.ProcessingEnvironment context, javax.lang.model.element.TypeElement core)
static boolean	hasInitDeclaration(javax.lang.model.element.TypeElement core)
static boolean	hasLocalFieldDecls(javax.annotation.processing.ProcessingEnvironment context, javax.lang.model.element.TypeElement core)
static boolean	hasRunDeclaration(javax.lang.model.element.TypeElement core)
static boolean	hasStateFieldDecl(javax.annotation.processing.ProcessingEnvironment context, javax.lang.model.element.TypeElement core)
static boolean	isActive(javax.lang.model.element.TypeElement core)
static boolean	isCapsuleFieldDecl(javax.annotation.processing.ProcessingEnvironment context, javax.lang.model.element.Element elem)
static boolean	isImportFieldDecl(javax.annotation.processing.ProcessingEnvironment context, javax.lang.model.element.Element elem)
static boolean	isLocalFieldDecl(javax.annotation.processing.ProcessingEnvironment context, javax.lang.model.element.Element elem)
static boolean	isPaniniCustom(javax.lang.model.type.TypeMirror returnType)
static boolean	isProcedure(javax.lang.model.element.Element elem)
static boolean	isRootCapsule(javax.annotation.processing.ProcessingEnvironment context, javax.lang.model.element.TypeElement core) A capsule is a "root" capsule if and only if it is active and has no `@Import` fields.
static boolean	isSpecialPaniniDecl(javax.lang.model.element.Element elem)
static boolean	isStateFieldDecl(javax.annotation.processing.ProcessingEnvironment context, javax.lang.model.element.Element elem)
static java.lang.String	qualifiedCapsuleCoreName(javax.lang.model.element.TypeElement core)
static java.lang.String	qualifiedCapsuleName(javax.lang.model.element.TypeElement core)
static java.lang.String	qualifiedSignatureName(javax.lang.model.element.TypeElement core)
static java.lang.String	qualifiedTesterName(javax.lang.model.element.TypeElement tester)
static java.lang.String	simpleCapsuleCoreName(javax.lang.model.element.TypeElement core)
static java.lang.String	simpleCapsuleName(javax.lang.model.element.TypeElement core)
static java.lang.String	simpleSignatureName(javax.lang.model.element.TypeElement core)
static java.lang.String	simpleTesterName(javax.lang.model.element.TypeElement tester)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MESSAGE_PACKAGE

public static final java.lang.String DEFAULT_MESSAGE_PACKAGE

See Also:

Constant Field Values

DEFAULT_FUTURE_PACKAGE

public static final java.lang.String DEFAULT_FUTURE_PACKAGE

See Also:

Constant Field Values

DEFAULT_DUCK_PACKAGE

public static final java.lang.String DEFAULT_DUCK_PACKAGE

See Also:

Constant Field Values

CAPSULE_CORE_SUFFIX

public static final java.lang.String CAPSULE_CORE_SUFFIX

See Also:

Constant Field Values

CAPSULE_TEST_CORE_SUFFIX

public static final java.lang.String CAPSULE_TEST_CORE_SUFFIX

See Also:

Constant Field Values

CAPSULE_TEST_SUFFIX

public static final java.lang.String CAPSULE_TEST_SUFFIX

See Also:

Constant Field Values

SIGNATURE_CORE_SUFFIX

public static final java.lang.String SIGNATURE_CORE_SUFFIX

See Also:

Constant Field Values

specialPaniniDecls

public static final java.lang.String[] specialPaniniDecls

Constructor Detail

PaniniModel

public PaniniModel()

Method Detail

isPaniniCustom

public static boolean isPaniniCustom(javax.lang.model.type.TypeMirror returnType)

isProcedure

public static boolean isProcedure(javax.lang.model.element.Element elem)

isSpecialPaniniDecl

public static boolean isSpecialPaniniDecl(javax.lang.model.element.Element elem)

isActive

public static boolean isActive(javax.lang.model.element.TypeElement core)

Returns:

`true` if and only if the given capsule core describes an active capsule. Note: This method is (currently) equivalent to calling `hasRunDeclaration()`. Warning: This method *assumes* that `core` is a well-defined capsule core (i.e. `core` passes all checks).

hasRunDeclaration

public static boolean hasRunDeclaration(javax.lang.model.element.TypeElement core)

Returns:

`true` if and only if the given capsule core has a `run()` declaration/method. Warning: This method *assumes* that `core` is a well-defined capsule core (i.e. `core` passes all checks).

hasInitDeclaration

public static boolean hasInitDeclaration(javax.lang.model.element.TypeElement core)

Returns:

`true` if and only if the given capsule core has an `init()` declaration/method. Warning: This method *assumes* that `core` is a well-defined capsule core (i.e. `core` passes all checks).

simpleCapsuleCoreName

public static java.lang.String simpleCapsuleCoreName(javax.lang.model.element.TypeElement core)

Returns:

The name of the simple (i.e. unqualified) type of the given capsule core type.

qualifiedCapsuleCoreName

public static java.lang.String qualifiedCapsuleCoreName(javax.lang.model.element.TypeElement core)

Returns:

The name of the fully-qualified type of the given capsule core type.

simpleCapsuleName

public static java.lang.String simpleCapsuleName(javax.lang.model.element.TypeElement core)

Returns:

The name of the simple (i.e. unqualified) capsule type associated with the given capsule core type. Assumes that the given capsule core type is suffixed by `CAPSULE_CORE_SUFFIX`. This is a useful helper method for dropping the `CAPSULE_CORE_SUFFIX`.

qualifiedCapsuleName

public static java.lang.String qualifiedCapsuleName(javax.lang.model.element.TypeElement core)

Returns:

The name of the fully-qualified capsule type associated with the given capsule core type. Assumes that the given capsule core type is suffixed by `CAPSULE_CORE_SUFFIX`. This is a useful helper method for dropping the `CAPSULE_CORE_SUFFIX`.

simpleSignatureName

public static java.lang.String simpleSignatureName(javax.lang.model.element.TypeElement core)

qualifiedSignatureName

public static java.lang.String qualifiedSignatureName(javax.lang.model.element.TypeElement core)

simpleTesterName

public static java.lang.String simpleTesterName(javax.lang.model.element.TypeElement tester)

Returns:

The name of the simple (i.e. unqualified) tester type associated with the given capsule tester core type. Assumes that the given tester core type is suffixed by `CAPSULE_TESTER_SUFFIX`. This is a useful helper method for dropping the `CAPSULE_TESTER_SUFFIX`.

qualifiedTesterName

public static java.lang.String qualifiedTesterName(javax.lang.model.element.TypeElement tester)

Returns:

The name of the fully-qualified tester type associated with the given tester core type. Assumes that the given tester core type is suffixed by `CAPSULE_TESTER_SUFFIX`. This is a useful helper method for dropping the `CAPSULE_TESTER_SUFFIX`.

isCapsuleFieldDecl

public static boolean isCapsuleFieldDecl(javax.annotation.processing.ProcessingEnvironment context,
                                         javax.lang.model.element.Element elem)

hasCapsuleFieldDecls

public static boolean hasCapsuleFieldDecls(javax.annotation.processing.ProcessingEnvironment context,
                                           javax.lang.model.element.TypeElement core)

getCapsuleFieldDecls

public static java.util.List<javax.lang.model.element.VariableElement> getCapsuleFieldDecls(javax.annotation.processing.ProcessingEnvironment context,
                                                                                            javax.lang.model.element.TypeElement core)

isLocalFieldDecl

public static boolean isLocalFieldDecl(javax.annotation.processing.ProcessingEnvironment context,
                                       javax.lang.model.element.Element elem)

hasLocalFieldDecls

public static boolean hasLocalFieldDecls(javax.annotation.processing.ProcessingEnvironment context,
                                         javax.lang.model.element.TypeElement core)

getLocalFieldDecls

public static java.util.List<javax.lang.model.element.VariableElement> getLocalFieldDecls(javax.annotation.processing.ProcessingEnvironment context,
                                                                                          javax.lang.model.element.TypeElement core)

isImportFieldDecl

public static boolean isImportFieldDecl(javax.annotation.processing.ProcessingEnvironment context,
                                        javax.lang.model.element.Element elem)

hasImportFieldDecls

public static boolean hasImportFieldDecls(javax.annotation.processing.ProcessingEnvironment context,
                                          javax.lang.model.element.TypeElement core)

getImportFieldDecls

public static java.util.List<javax.lang.model.element.VariableElement> getImportFieldDecls(javax.annotation.processing.ProcessingEnvironment context,
                                                                                           javax.lang.model.element.TypeElement core)

isStateFieldDecl

public static boolean isStateFieldDecl(javax.annotation.processing.ProcessingEnvironment context,
                                       javax.lang.model.element.Element elem)

hasStateFieldDecl

public static boolean hasStateFieldDecl(javax.annotation.processing.ProcessingEnvironment context,
                                        javax.lang.model.element.TypeElement core)

getStateFieldDecls

public static java.util.List<javax.lang.model.element.VariableElement> getStateFieldDecls(javax.annotation.processing.ProcessingEnvironment context,
                                                                                          javax.lang.model.element.TypeElement core)

isRootCapsule

public static boolean isRootCapsule(javax.annotation.processing.ProcessingEnvironment context,
                                    javax.lang.model.element.TypeElement core)

A capsule is a "root" capsule if and only if it is active and has no `@Import` fields.

hasCapsuleDesignDecl

public static boolean hasCapsuleDesignDecl(javax.lang.model.element.TypeElement core)

Returns `true` if and only if the given capsule core has a design declaration.

getCapsuleDesignDecl

public static javax.lang.model.element.ExecutableElement getCapsuleDesignDecl(javax.lang.model.element.TypeElement core)

Returns the `ExecutableElement` representing the given capsule core design declaration, or returns `null` if there is no such declaration. Warning: This method *assumes* that `core` is a well-defined capsule core (i.e. `core` passes all checks).

getProcedures

public static java.util.List<javax.lang.model.element.ExecutableElement> getProcedures(javax.lang.model.element.TypeElement core)

Returns a list of all of the procedures (represented as `ExcecutableElement`s) defined on the given `core`.

buildExportMethodDecl

public static java.lang.String buildExportMethodDecl(javax.annotation.processing.ProcessingEnvironment context,
                                                     javax.lang.model.element.TypeElement core)

Inspects the given capsule core, finds the design declaration on it, then returns a String representation of a `imports()` method declaration.

For example, if a user-defined capsule core has the form

 @Capsule
 public class BazCore {
     @Import Foo foo;
     @Import Bar bar;
     // ...
 }
 

where `foo` and `bar` are the only `@Import`-annotated fields on the core, then this method would return the `String`

 public void imports(Foo foo, Bar bar)
 

Note: If the `core` has no `@Import` capsules, then this method returns `null`.