Package org.codehaus.groovy.transform.trait

Class Traits

java.lang.Object
org.codehaus.groovy.transform.trait.Traits
public abstract class Traits extends Object
A collection of utility methods used to deal with traits.
Since:
2.3.0

  • Field Details

    • IMPLEMENTED_CLASSNODE

      public static final ClassNode IMPLEMENTED_CLASSNODE
      Class node for Traits.Implemented.

    • TRAITBRIDGE_CLASSNODE

      public static final ClassNode TRAITBRIDGE_CLASSNODE
      Class node for Traits.TraitBridge.

    • TRAIT_CLASS

      public static final Class<Trait> TRAIT_CLASS
      Runtime annotation type that marks Groovy traits.

    • TRAIT_CLASSNODE

      public static final ClassNode TRAIT_CLASSNODE
      Class node for Trait.

    • GENERATED_PROXY_CLASSNODE

      public static final ClassNode GENERATED_PROXY_CLASSNODE
      Class node for GeneratedGroovyProxy.

    • SELFTYPE_CLASSNODE

      public static final ClassNode SELFTYPE_CLASSNODE
      Class node for SelfType.

    • THIS_OBJECT

      public static final String THIS_OBJECT
      Synthetic parameter name for the current trait receiver.
      See Also:

    • STATIC_THIS_OBJECT

      public static final String STATIC_THIS_OBJECT
      Synthetic parameter name for the current static trait receiver.
      See Also:

  • Constructor Details

    • Traits

      public Traits()

  • Method Details

    • findHelper

      public static ClassNode findHelper(ClassNode trait)
      Returns the generated helper class for a trait.
      Parameters:
      trait - the trait class node
      Returns:
      the helper class node

    • findFieldHelper

      public static ClassNode findFieldHelper(ClassNode trait)
      Returns the generated instance field helper class for a trait.
      Parameters:
      trait - the trait class node
      Returns:
      the field helper class node, or null if none exists

    • findStaticFieldHelper

      public static ClassNode findStaticFieldHelper(ClassNode trait)
      Returns the generated static field helper class for a trait.
      Parameters:
      trait - the trait class node
      Returns:
      the static field helper class node, or null if none exists

    • isTrait

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

    • isTrait

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

    • isAnnotatedWithTrait

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

    • hasDefaultImplementation

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

    • hasDefaultImplementation

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

    • isBridgeMethod

      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 - a method
      Returns:
      true if the method bridges to a trait default implementation

    • getBridgeMethodTarget

      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 - a method
      Returns:
      null if it is not a method implemented in a trait. If it is, returns the method from the trait class.

    • getAsType

      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 DefaultGroovyMethods.asType(java.lang.Object, Class)
      Parameters:
      self - an object to be coerced to some class
      clazz - the class to be coerced to
      Returns:
      the object coerced to the target class, or the proxy instance if it is compatible with the target class.

    • decomposeSuperCallName

      public static String[] decomposeSuperCallName(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.

    • collectAllInterfacesReverseOrder

      public static LinkedHashSet<ClassNode> collectAllInterfacesReverseOrder(ClassNode cNode, 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 - a class node
      interfaces - ordered set of interfaces

    • collectSelfTypes

      public static LinkedHashSet<ClassNode> collectSelfTypes(ClassNode receiver, 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 - a class node that may implement a trait
      selfTypes - a set where the self types will be put
      Returns:
      the selfTypes collection
      Since:
      2.4.0

    • collectSelfTypes

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

    • findTraits

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