Apache Groovy 3.0.20 · org.codehaus.groovy.transform.trait.Traits

Modifier and Type	Class and Description
public static @interface	Traits.Implemented Internal annotation used to indicate which methods in a trait interface have a default implementation.
public static @interface	Traits.TraitBridge Internal annotation used to indicate that a method is a bridge method to a trait default implementation.

Field Summary

Modifier and Type	Field and Description
pack-priv static final String	DIRECT_GETTER_SUFFIX
pack-priv static final String	DIRECT_SETTER_SUFFIX
pack-priv static final String	FIELD_HELPER
pack-priv static final String	FIELD_PREFIX
pack-priv static final int	FIELD_PREFIX_MASK
pack-priv static final List<Integer>	FIELD_PREFIXES
public static final ClassNode	GENERATED_PROXY_CLASSNODE
public static final ClassNode	IMPLEMENTED_CLASSNODE
pack-priv static final String	INIT_METHOD
pack-priv static final String	PRIVATE_FIELD_PREFIX
pack-priv static final String	PUBLIC_FIELD_PREFIX
public static final ClassNode	SELFTYPE_CLASSNODE
pack-priv static final String	STATIC_FIELD_HELPER
pack-priv static final String	STATIC_FIELD_PREFIX
pack-priv static final String	STATIC_INIT_METHOD
public static final String	STATIC_THIS_OBJECT
pack-priv static final String	SUPER_TRAIT_METHOD_PREFIX
public static final String	THIS_OBJECT
public static final Class<Trait>	TRAIT_CLASS
public static final ClassNode	TRAIT_CLASSNODE
pack-priv static final String	TRAIT_HELPER
pack-priv static final String	TRAIT_TYPE_NAME
public static final ClassNode	TRAITBRIDGE_CLASSNODE

Constructor Summary

Access	Constructor and Description
public	Traits()

Method Summary

Modifier and Type	Method and Description
public static LinkedHashSet<ClassNode>	collectAllInterfacesReverseOrder(final ClassNode a class node cNode, final LinkedHashSet<ClassNode> ordered set of interfaces interfaces) Collects all interfaces of a class node, but reverses the order of the declaration of direct interfaces of this class node.
public static LinkedHashSet<ClassNode>	Returns: the `selfTypes` collection collectSelfTypes(final ClassNode a class node that may implement a trait receiver, final LinkedHashSet<ClassNode> a set where the self types will be put selfTypes) Collects all the self types that a type should extend or implement, given the traits is implements.
public static LinkedHashSet<ClassNode>	Returns: the `selfTypes` collection collectSelfTypes(final ClassNode a class node that may implement a trait receiver, final LinkedHashSet<ClassNode> a set where the self types will be put selfTypes, final boolean should the interfaces that the node implements be collected too checkInterfaces, final boolean should we collect from the superclass too checkSuperClass) Collects all the self types that a type should extend or implement, given the traits is implements.
public static String[]	decomposeSuperCallName(final String methodName) Returns the trait and method names derived from super-trait name scheme or `null` if the method name doesn't correspond to a trait method.
pack-priv static String	fieldHelperClassName(final ClassNode traitNode)
public static ClassNode	findFieldHelper(final ClassNode trait)
public static ClassNode	findHelper(final ClassNode trait)
pack-priv static TraitHelpersTuple	findHelpers(final ClassNode trait)
public static ClassNode	findStaticFieldHelper(final ClassNode trait)
public static List<ClassNode>	Returns: the list of ordered trait classnodes findTraits(final ClassNode the given classnode cNode) Find all traits associated with the given type.
public static <T> T	Returns: the object coerced to the target class, or the proxy instance if it is compatible with the target class. getAsType(Object an object to be coerced to some class self, Class<T> the class to be coerced to clazz) Converts a class implementing some trait into a target class.
public static Method	Returns: null if it is not a method implemented in a trait. If it is, returns the method from the trait class. getBridgeMethodTarget(Method a method node someMethod) Reflection API to find the method corresponding to the default implementation of a trait, given a bridge method.
pack-priv static String	getSuperTraitMethodName(ClassNode trait, String method)
public static boolean	Returns: true if the method has a default implementation in the trait hasDefaultImplementation(final MethodNode a method node method) Indicates whether a method in a trait interface has a default implementation.
public static boolean	Returns: true if the method has a default implementation in the trait hasDefaultImplementation(final Method a method node method) Indicates whether a method in a trait interface has a default implementation.
pack-priv static String	helperClassName(final ClassNode traitNode)
pack-priv static String	helperGetterName(final FieldNode field)
pack-priv static String	helperSetterName(final FieldNode field)
public static boolean	Returns: true if the specified class node is annotated with the `Trait` interface. isAnnotatedWithTrait(final ClassNode a class node cNode) Returns true if the specified class node is annotated with the `Trait` interface.
public static boolean	Returns: null if it is not a method implemented in a trait. If it is, returns the method from the trait class. isBridgeMethod(Method a method node someMethod) Reflection API to indicate whether some method is a bridge method to the default implementation of a trait.
public static boolean	Returns: true if the classnode represents a trait isTrait(final ClassNode a class node to test cNode) Returns true if the specified class node is a trait.
public static boolean	Returns: true if the classnode represents a trait isTrait(final Class<?> a class to test clazz) Returns true if the specified class is a trait.
pack-priv static String	remappedFieldName(final ClassNode traitNode, final String name)
pack-priv static String	staticFieldHelperClassName(final ClassNode traitNode)
private static ClassNode	unwrapOwner(ClassNode owner)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DIRECT_GETTER_SUFFIX	back to summary
pack-priv static final String DIRECT_GETTER_SUFFIX

DIRECT_SETTER_SUFFIX	back to summary
pack-priv static final String DIRECT_SETTER_SUFFIX

FIELD_HELPER	back to summary
pack-priv static final String FIELD_HELPER

FIELD_PREFIX	back to summary
pack-priv static final String FIELD_PREFIX

FIELD_PREFIX_MASK	back to summary
pack-priv static final int FIELD_PREFIX_MASK

FIELD_PREFIXES	back to summary
pack-priv static final List<Integer> FIELD_PREFIXES

GENERATED_PROXY_CLASSNODE	back to summary
public static final ClassNode GENERATED_PROXY_CLASSNODE

IMPLEMENTED_CLASSNODE	back to summary
public static final ClassNode IMPLEMENTED_CLASSNODE

INIT_METHOD	back to summary
pack-priv static final String INIT_METHOD

PRIVATE_FIELD_PREFIX	back to summary
pack-priv static final String PRIVATE_FIELD_PREFIX

PUBLIC_FIELD_PREFIX	back to summary
pack-priv static final String PUBLIC_FIELD_PREFIX

SELFTYPE_CLASSNODE	back to summary
public static final ClassNode SELFTYPE_CLASSNODE

STATIC_FIELD_HELPER	back to summary
pack-priv static final String STATIC_FIELD_HELPER

STATIC_FIELD_PREFIX	back to summary
pack-priv static final String STATIC_FIELD_PREFIX

STATIC_INIT_METHOD	back to summary
pack-priv static final String STATIC_INIT_METHOD

STATIC_THIS_OBJECT	back to summary
public static final String STATIC_THIS_OBJECT

SUPER_TRAIT_METHOD_PREFIX	back to summary
pack-priv static final String SUPER_TRAIT_METHOD_PREFIX

THIS_OBJECT	back to summary
public static final String THIS_OBJECT

TRAIT_CLASS	back to summary
public static final Class<Trait> TRAIT_CLASS

TRAIT_CLASSNODE	back to summary
public static final ClassNode TRAIT_CLASSNODE

TRAIT_HELPER	back to summary
pack-priv static final String TRAIT_HELPER

TRAIT_TYPE_NAME	back to summary
pack-priv static final String TRAIT_TYPE_NAME

TRAITBRIDGE_CLASSNODE	back to summary
public static final ClassNode TRAITBRIDGE_CLASSNODE

Constructor Detail

Traits	back to summary
public Traits()

Method Detail

collectAllInterfacesReverseOrder	back to summary
public static LinkedHashSet<ClassNode> collectAllInterfacesReverseOrder(final ClassNode cNode, final LinkedHashSet<ClassNode> interfaces) Collects all interfaces of a class node, but reverses the order of the declaration of direct interfaces of this class node. This is used to make sure a trait implementing A,B where both A and B have the same method will take the method from B (latest), aligning the behavior with categories. Parameters cNode:ClassNode a class node interfaces:LinkedHashSet<ClassNode> ordered set of interfaces

collectAllInterfacesReverseOrder

back to summary

public static LinkedHashSet<ClassNode> collectAllInterfacesReverseOrder(final ClassNode cNode, final LinkedHashSet<ClassNode> interfaces)

Collects all interfaces of a class node, but reverses the order of the declaration of direct interfaces of this class node. This is used to make sure a trait implementing A,B where both A and B have the same method will take the method from B (latest), aligning the behavior with categories.

Parameters

cNode:ClassNode: a class node
interfaces:LinkedHashSet<ClassNode>: ordered set of interfaces

collectSelfTypes back to summary

collectSelfTypes	back to summary
public static LinkedHashSet<ClassNode> collectSelfTypes(final ClassNode receiver, final LinkedHashSet<ClassNode> selfTypes) Collects all the self types that a type should extend or implement, given the traits is implements. Collects from interfaces and superclasses too. Parameters receiver:ClassNode a class node that may implement a trait selfTypes:LinkedHashSet<ClassNode> a set where the self types will be put Returns:LinkedHashSet<ClassNode> the `selfTypes` collection Since 2.4.0

public static LinkedHashSet<ClassNode> collectSelfTypes(final ClassNode receiver, final LinkedHashSet<ClassNode> selfTypes)

Collects all the self types that a type should extend or implement, given the traits is implements. Collects from interfaces and superclasses too.

Parameters

receiver:ClassNode: a class node that may implement a trait
selfTypes:LinkedHashSet<ClassNode>: a set where the self types will be put

Returns:LinkedHashSet<ClassNode>

the selfTypes collection

Since

2.4.0

collectSelfTypes back to summary

collectSelfTypes	back to summary
public static LinkedHashSet<ClassNode> collectSelfTypes(final ClassNode receiver, final LinkedHashSet<ClassNode> selfTypes, final boolean checkInterfaces, final boolean checkSuperClass) Collects all the self types that a type should extend or implement, given the traits is implements. Parameters receiver:ClassNode a class node that may implement a trait selfTypes:LinkedHashSet<ClassNode> a set where the self types will be put checkInterfaces:boolean should the interfaces that the node implements be collected too checkSuperClass:boolean should we collect from the superclass too Returns:LinkedHashSet<ClassNode> the `selfTypes` collection Since 2.4.0

public static LinkedHashSet<ClassNode> collectSelfTypes(final ClassNode receiver, final LinkedHashSet<ClassNode> selfTypes, final boolean checkInterfaces, final boolean checkSuperClass)

Collects all the self types that a type should extend or implement, given the traits is implements.

Parameters

receiver:ClassNode: a class node that may implement a trait
selfTypes:LinkedHashSet<ClassNode>: a set where the self types will be put
checkInterfaces:boolean: should the interfaces that the node implements be collected too
checkSuperClass:boolean: should we collect from the superclass too

Returns:LinkedHashSet<ClassNode>

the selfTypes collection

Since

2.4.0

decomposeSuperCallName	back to summary
public static String[] decomposeSuperCallName(final String methodName) Returns the trait and method names derived from super-trait name scheme or `null` if the method name doesn't correspond to a trait method.

fieldHelperClassName	back to summary
pack-priv static String fieldHelperClassName(final ClassNode traitNode)

findFieldHelper	back to summary
public static ClassNode findFieldHelper(final ClassNode trait)

findHelper	back to summary
public static ClassNode findHelper(final ClassNode trait)

findHelpers	back to summary
pack-priv static TraitHelpersTuple findHelpers(final ClassNode trait)

findStaticFieldHelper	back to summary
public static ClassNode findStaticFieldHelper(final ClassNode trait)

findTraits	back to summary
public static List<ClassNode> findTraits(final ClassNode cNode) Find all traits associated with the given type. Parameters cNode:ClassNode the given classnode Returns:List<ClassNode> the list of ordered trait classnodes

findTraits

back to summary

public static List<ClassNode> findTraits(final ClassNode cNode)

Find all traits associated with the given type.

Parameters

cNode:ClassNode: the given classnode

Returns:List<ClassNode>

the list of ordered trait classnodes

getAsType back to summary

getAsType	back to summary
public static <T> T getAsType(Object self, Class<T> clazz) Converts a class implementing some trait into a target class. If the trait is a dynamic proxy and that the target class is assignable to the target object of the proxy, then the target object is returned. Otherwise, falls back to `org.codehaus.groovy.runtime.DefaultGroovyMethods#asType(java.lang.Object, Class)` Parameters self:Object an object to be coerced to some class clazz:Class<T> the class to be coerced to Returns:T the object coerced to the target class, or the proxy instance if it is compatible with the target class. Annotations @SuppressWarnings:unchecked

public static <T> T getAsType(Object self, Class<T> clazz)

Converts a class implementing some trait into a target class. If the trait is a dynamic proxy and that the target class is assignable to the target object of the proxy, then the target object is returned. Otherwise, falls back to org.codehaus.groovy.runtime.DefaultGroovyMethods#asType(java.lang.Object, Class)

Parameters

self:Object: an object to be coerced to some class
clazz:Class<T>: the class to be coerced to

Returns:T

the object coerced to the target class, or the proxy instance if it is compatible with the target class.

Annotations

@SuppressWarnings:unchecked

getBridgeMethodTarget	back to summary
public static Method getBridgeMethodTarget(Method someMethod) Reflection API to find the method corresponding to the default implementation of a trait, given a bridge method. Parameters someMethod:Method a method node Returns:Method null if it is not a method implemented in a trait. If it is, returns the method from the trait class.

getBridgeMethodTarget

back to summary

public static Method getBridgeMethodTarget(Method someMethod)

Reflection API to find the method corresponding to the default implementation of a trait, given a bridge method.

Parameters

someMethod:Method: a method node

Returns:Method

null if it is not a method implemented in a trait. If it is, returns the method from the trait class.

getSuperTraitMethodName	back to summary
pack-priv static String getSuperTraitMethodName(ClassNode trait, String method)

hasDefaultImplementation	back to summary
public static boolean hasDefaultImplementation(final MethodNode method) Indicates whether a method in a trait interface has a default implementation. Parameters method:MethodNode a method node Returns:boolean true if the method has a default implementation in the trait

hasDefaultImplementation

back to summary

public static boolean hasDefaultImplementation(final MethodNode method)

Indicates whether a method in a trait interface has a default implementation.

Parameters

method:MethodNode: a method node

Returns:boolean

true if the method has a default implementation in the trait

hasDefaultImplementation	back to summary
public static boolean hasDefaultImplementation(final Method method) Indicates whether a method in a trait interface has a default implementation. Parameters method:Method a method node Returns:boolean true if the method has a default implementation in the trait

hasDefaultImplementation

back to summary

public static boolean hasDefaultImplementation(final Method method)

Indicates whether a method in a trait interface has a default implementation.

Parameters

method:Method: a method node

Returns:boolean

true if the method has a default implementation in the trait

helperClassName	back to summary
pack-priv static String helperClassName(final ClassNode traitNode)

helperGetterName	back to summary
pack-priv static String helperGetterName(final FieldNode field)

helperSetterName	back to summary
pack-priv static String helperSetterName(final FieldNode field)

isAnnotatedWithTrait back to summary

isAnnotatedWithTrait	back to summary
public static boolean isAnnotatedWithTrait(final ClassNode cNode) Returns true if the specified class node is annotated with the `Trait` interface. Parameters cNode:ClassNode a class node Returns:boolean true if the specified class node is annotated with the `Trait` interface.

public static boolean isAnnotatedWithTrait(final ClassNode cNode)

Returns true if the specified class node is annotated with the Trait interface.

Parameters

cNode:ClassNode: a class node

Returns:boolean

true if the specified class node is annotated with the Trait interface.

isBridgeMethod	back to summary
public static boolean isBridgeMethod(Method someMethod) Reflection API to indicate whether some method is a bridge method to the default implementation of a trait. Parameters someMethod:Method a method node Returns:boolean null if it is not a method implemented in a trait. If it is, returns the method from the trait class.

isBridgeMethod

back to summary

public static boolean isBridgeMethod(Method someMethod)

Reflection API to indicate whether some method is a bridge method to the default implementation of a trait.

Parameters

someMethod:Method: a method node

Returns:boolean

null if it is not a method implemented in a trait. If it is, returns the method from the trait class.

isTrait	back to summary
public static boolean isTrait(final ClassNode cNode) Returns true if the specified class node is a trait. Parameters cNode:ClassNode a class node to test Returns:boolean true if the classnode represents a trait

isTrait

back to summary

public static boolean isTrait(final ClassNode cNode)

Returns true if the specified class node is a trait.

Parameters

cNode:ClassNode: a class node to test

Returns:boolean

true if the classnode represents a trait

isTrait	back to summary
public static boolean isTrait(final Class<?> clazz) Returns true if the specified class is a trait. Parameters clazz:Class<?> a class to test Returns:boolean true if the classnode represents a trait

isTrait

back to summary

public static boolean isTrait(final Class<?> clazz)

Returns true if the specified class is a trait.

Parameters

clazz:Class<?>: a class to test

Returns:boolean

true if the classnode represents a trait

remappedFieldName	back to summary
pack-priv static String remappedFieldName(final ClassNode traitNode, final String name)

staticFieldHelperClassName	back to summary
pack-priv static String staticFieldHelperClassName(final ClassNode traitNode)

unwrapOwner	back to summary
private static ClassNode unwrapOwner(ClassNode owner)

Modifier and Type	Method and Description
public String	Returns: The method descriptor of the method from the trait desc()
public Class<?>	Returns: the trait class traitClass()

public abstract Class Traits

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public @Interface Traits.Implemented

Method Summary

public @Interface Traits.TraitBridge

Method Summary

Method Detail