Package com.iizigo.java.prop

Class EditorMethodReference2

  • All Implemented Interfaces:
    IClassReferenceListener, EventListener, IGProp<GProp<?>[]>, IPropCnr, java.lang.Cloneable
    Direct Known Subclasses:
    EditorFieldActor
    public abstract class EditorMethodReference2
extends MethodReference2
implements IClassReferenceListener
    The Designer version the Method Reference "2" property class hold the reference to a Method that is in a Java class.

    Two variants are supported:

    1. As for classic MethodReference:
      a Java class reference "ClassReference" is held by a parent container in the tree, and this method reference is a simple name without '.' and is the method in the class.
    2. a static method reference in a class, where this name is the fully qualified class name with the method name last.
    Author:
    Christopher Mindus

    • Field Detail

      • ERROR_ID

        public static final java.lang.String ERROR_ID
        The ID of the property error.
        See Also:
        Constant Field Values

    • Constructor Detail

      • EditorMethodReference2

        public EditorMethodReference2()
        Creates a Method Reference property with no name and with a null value.

      • EditorMethodReference2

        public EditorMethodReference2​(Atom propertyAtom)
        Creates a Method Reference property with the specified name with a null value.
        Parameters:
        propertyAtom - the property atom.

      • EditorMethodReference2

        public EditorMethodReference2​(Atom propertyAtom,
                              java.lang.String newValue)
        Creates a Method Reference property with the specified name and value.
        Parameters:
        propertyAtom - the property atom.
        newValue - the new string value for the property.

    • Method Detail

      • clone

        public EditorMethodReference2 clone()
        Creates a clone out of this property. The cloning is overridden by the super classes in order to handle cloning of its class variables appropriately.

        Cloning is used for "virtualization" of a property tree in the server. Client property classes will therefore throw CloneNotSupportedException.

        Once a tree has been cloned, the change-flag is reset, and the create-flag is set. All listeners are also removed! The new cloned property is an orphan, i.e. has no parent set.

        Note that the cloning process is done WITHOUT thread synchronization for performance reasons, thus no modifications should be done to the tree!

        Overrides:
        clone in class PropCnr

      • getRequiredNonStaticAnnotation

        public abstract java.lang.String getRequiredNonStaticAnnotation()
        Get the fully qualified annotation name that the Java Class should be annotated with when non-static.
        Returns:
        Gets the required annotation name, null for none.

      • getRequiredStaticAnnotation

        public abstract java.lang.String getRequiredStaticAnnotation()
        Get the fully qualified annotation name that the Java Class should be annotated with when static.
        Returns:
        Gets the required annotation name, null for none.

      • getRequiredInterface

        public java.lang.String getRequiredInterface()
        Gets the fully qualified interface name that the Java Class should implement.
        Specified by:
        getRequiredInterface in interface IClassReferenceListener
        Returns:
        Gets the required interface name, null for none.

      • getRequiredClassAnnotation

        public java.lang.String getRequiredClassAnnotation()
        Get the fully qualified annotation name that the Java Class should be annotated with.
        Specified by:
        getRequiredClassAnnotation in interface IClassReferenceListener
        Returns:
        Gets the required annotation name, null for none.

      • isAnnotationBackReferenceRequired

        public boolean isAnnotationBackReferenceRequired()
        Checks if the Class Reference require an annotation back-reference.
        Specified by:
        isAnnotationBackReferenceRequired in interface IClassReferenceListener
        Returns:
        true if the annotation is required to have a back-reference on the "ref" member value pair to the Class Reference owner.

      • onEventSelf

        public void onEventSelf​(GEvent event)
        Event processing for Java Class Reference changed.
        Specified by:
        onEventSelf in interface IGProp<GProp<?>[]>
        Overrides:
        onEventSelf in class GProp<GProp<?>[]>
        Parameters:
        event - The property event.

      • onReferenceEvent

        protected void onReferenceEvent​(ResolveReferencesEvent event)
        Called to perform reference resolving. A property should override this method if it needs to perform reference resolving and validation.

        Subclasses override this method and only subclasses extending PropCnr needs to call super.onReferenceEvent(ResolveReferenceEvent event).

        Overrides:
        onReferenceEvent in class PropCnr
        Parameters:
        event - The resolve references event.

      • lookup

        public MethodLookup lookup​(GProp<?> propInProject)
        Checks the reference validity from the Designer.

      • onPropDispose

        protected void onPropDispose()
        Called when a property is disposed of.
        Overrides:
        onPropDispose in class PropCnr

      • onResolve

        public void onResolve​(JavaClass reference,
                      boolean isClassFound,
                      java.lang.String errorMessage)
        Notifies the Class Reference of resolve result.
        Specified by:
        onResolve in interface IClassReferenceListener
        Parameters:
        reference - The Class Reference.
        isClassFound - Flag indicating class is found, but interface is not implemented (when true) or annotation is missing.
        errorMessage - The error message, or null to clear the error.

      • resolve

        public MethodLookup resolve()
        Resolves the reference.
        Returns:
        The method Object (IMethod for Designer), or class/type instance (IType for Designer) if class is present but not the method, or a String for the error (can also be null e.g. for no method name). Do not use the return code in other places than the Designer.

      • getJavaElement

        public org.eclipse.jdt.core.IJavaElement getJavaElement()
        Gets the Java element in resolve, could be a IType or IMethod (even the wrong IMethod due to missing annotation or compile error). This should only be used e.g. in the Show in Java Editor function.

      • isAnnotationMissing

        public boolean isAnnotationMissing()
        Checks for missing annotation. This call should only be used in the Designer.
        Returns:
        null For not missing or can't do anything, otherwise the JavaClass instance.

      • getDescription

        public java.lang.String getDescription()
        Gets the description of the reference from the annotation.
        Returns:
        The description from the annotation, or an error message if not resolved.

      • onJavaChangedSWT

        public void onJavaChangedSWT​(JavaClass reference)
        Called when the source has changed and is recompiled on disk or in-memory reconcile. This method is called in the SWT thread only (in the Designer).
        Specified by:
        onJavaChangedSWT in interface IClassReferenceListener

      • onRename

        public void onRename​(JavaClass reference,
                     java.lang.String newName)
        Informs the listener that the fully qualified class name has been changed. This includes the class package as well as the name.
        Specified by:
        onRename in interface IClassReferenceListener
        Parameters:
        reference - The Class Reference.
        newName - The new fully qualified class name.

      • onMethodRenamed

        public void onMethodRenamed​(JavaClass reference,
                            java.lang.String oldName,
                            java.lang.String newName,
                            java.lang.String signature)
        Called when a method has been renamed in the class.
        Specified by:
        onMethodRenamed in interface IClassReferenceListener
        Parameters:
        reference - The Class Reference.
        oldName - Old name.
        newName - New name.
        signature - Signature of method as retrieved by JavaHelper.getSimpleSignature class in Designer.