Package org.emftext.language.java.extensions.commons

Class CommentableExtension

java.lang.Object
org.emftext.language.java.extensions.commons.CommentableExtension
public class CommentableExtension extends Object

  • Constructor Details

    • CommentableExtension

      public CommentableExtension()

  • Method Details

    • addBeforeContainingStatement

      public static void addBeforeContainingStatement(Commentable me, Statement statementToAdd)
      Adds the given statement before the statement that contains this element.
      Parameters:
      me - the context in which the statement is added.
      statementToAdd - the statement to add.

    • addAfterContainingStatement

      public static void addAfterContainingStatement(Commentable me, Statement statementToAdd)
      Adds the given statement after the statement that contains this element.
      Parameters:
      me - the context in which the statement is added.
      statementToAdd - the statement to add.

    • getParentByEType

      public static EObject getParentByEType(Commentable me, EClass type)
      Walks up the containment hierarchy and returns the first parent with the given type. If no such parent is found, null is returned.
      Parameters:
      me - the start object.
      type - the given type.
      Returns:
      the found parent or null.

    • getParentByType

      public static <T> T getParentByType(Commentable me, Class<T> type)
      Walks up the containment hierarchy and returns the first parent with the given type. If no such parent is found, null is returned.
      Type Parameters:
      T - the given type.
      Parameters:
      me - the start object.
      type - class object of the given type.
      Returns:
      the found parent or null.

    • getFirstChildByEType

      public static EObject getFirstChildByEType(Commentable me, EClass type)
      Searches for the first child with the given type. If no such child is found, null is returned.
      Parameters:
      me - the start object.
      type - the given type.
      Returns:
      the found child or null.

    • getFirstChildByType

      public static <T> T getFirstChildByType(Commentable me, Class<T> type)
      Searches for the first child with the given type. If no such child is found, null is returned.
      Type Parameters:
      T - the given type.
      Parameters:
      me - the start object.
      type - class object of the given type.
      Returns:
      the found child or null.

    • getChildrenByEType

      public static EList<EObject> getChildrenByEType(Commentable me, EClass type)
      Returns all children of the given type.
      Parameters:
      me - the start object.
      type - the given type.
      Returns:
      all children.

    • getChildrenByType

      public static <T> EList<T> getChildrenByType(Commentable me, Class<T> type)
      Returns all children of the given type.
      Type Parameters:
      T - the given type.
      Parameters:
      me - the start object.
      type - class object of the type.
      Returns:
      the children.

    • getConcreteClassifier

      public static ConcreteClassifier getConcreteClassifier(Commentable me, String name)
      Finds the ConcreteClassifier representing the class with the given classified name.
      Parameters:
      me - the context.
      name - classified name of the ConcreteClassifier
      Returns:
      the classifier.

    • getConcreteClassifiers

      public static EList<ConcreteClassifier> getConcreteClassifiers(Commentable me, String packageName, String classifierQuery)
      Finds all ConcreteClassifier representing the classes in the given package or a single class from that package.
      Parameters:
      me - the context.
      packageName - name of the package
      classifierQuery - * for all classifiers or name of a single classifier
      Returns:
      the classifier.

    • getLibClass

      public static Class getLibClass(Commentable me, String name)
      Finds the Class representing the class with the given name located in java.lang.
      Parameters:
      me - the context.
      name - name of the Class.
      Returns:
      the Class.

    • getLibInterface

      public static Interface getLibInterface(Commentable me, String name)
      Finds the Interface representing the interface with the given name located in java.lang.
      Parameters:
      me - the context.
      name - name of the Interface.
      Returns:
      the interface.

    • getClassClass

      public static Class getClassClass(Commentable me)
      Finds the Class representing java.lang.Class.
      Parameters:
      me - the context.
      Returns:
      the Class.

    • getObjectClass

      public static Class getObjectClass(Commentable me)
      Finds the Class representing java.lang.Object.
      Parameters:
      me - the context.
      Returns:
      the Class.

    • getStringClass

      public static Class getStringClass(Commentable me)
      Finds the Class representing java.lang.String.
      Parameters:
      me - the context.
      Returns:
      the Class.

    • getAnnotationInterface

      public static Interface getAnnotationInterface(Commentable me)
      Finds the Interface representing java.lang.annotation.Annotation.
      Parameters:
      me - the context.
      Returns:
      the Class.

    • getContainingConcreteClassifier

      public static ConcreteClassifier getContainingConcreteClassifier(Commentable me)
      Finds the containing classifier for the given element.
      Parameters:
      me - the context.
      Returns:
      containing classifier

    • getParentConcreteClassifier

      public static ConcreteClassifier getParentConcreteClassifier(Commentable me)
      Finds the classifier that is the parent of this element. If this element is an inner classifier the parent classifier does not necessarily contain this element, since it can reside in a different compilation unit when stored in byte code.
      Parameters:
      me - the context.
      Returns:
      containing classifier

    • getContainingAnonymousClass

      public static AnonymousClass getContainingAnonymousClass(Commentable me)
      Finds the containing anonymous class for the given element.
      Parameters:
      me - the context.
      Returns:
      containing anonymous class

    • getContainingCompilationUnit

      public static CompilationUnit getContainingCompilationUnit(Commentable me)
      Finds the containing compilation unit for the given element.
      Parameters:
      me - the given element.
      Returns:
      containing compilation unit

    • getContainingAnnotationInstance

      public static AnnotationInstance getContainingAnnotationInstance(Commentable me)
      Finds the containing annotation instance for the given element.
      Parameters:
      me - the given element.
      Returns:
      containing annotation instance

    • getContainingPackageName

      public static EList<String> getContainingPackageName(Commentable me)

    • getContainingContainerName

      public static EList<String> getContainingContainerName(Commentable me)