Class ReconcileContext


  • public class ReconcileContext
    extends Object
    The context of a reconcile event that is notified to interested compilation participants while a reconcile operation is running.

    A reconcile participant can get the AST for the reconcile-operation using getAST4(). If the participant modifies in any way the AST (either by modifying the source of the working copy, or modifying another entity that would result in different bindings for the AST), it is expected to reset the AST in the context using resetAST().

    A reconcile participant can also create and return problems using putProblems(String, CategorizedProblem[]). These problems are then reported to the problem requestor of the reconcile operation.

    Since:
    3.2
    See Also:
    CompilationParticipant.reconcile(ReconcileContext)
    Restriction:
    This class is not intended to be subclassed by clients.
    Restriction:
    This class is not intended to be instantiated by clients.
    • Constructor Detail

      • ReconcileContext

        public ReconcileContext​(org.eclipse.jdt.internal.core.ReconcileWorkingCopyOperation operation,
                                org.eclipse.jdt.internal.core.CompilationUnit workingCopy)
        Creates a reconcile context for the given reconcile operation.
        Parameters:
        operation - the reconcile operation
        Restriction:
        This constructor is not intended to be called by clients.
    • Method Detail

      • getAST3

        public CompilationUnit getAST3()
                                throws JavaModelException
        Deprecated.
        JLS3 has been deprecated. This method has been replaced by getAST4() which returns an AST with JLS4 level.
        Returns a resolved AST with JLS3 level. It is created from the current state of the working copy. Creates one if none exists yet. Returns null if the current state of the working copy doesn't allow the AST to be created (e.g. if the working copy's content cannot be parsed).

        If the AST level requested during reconciling is not AST.JLS3 or if binding resolutions was not requested, then a different AST is created. Note that this AST does not become the current AST and it is only valid for the requestor.

        Returns:
        the AST created from the current state of the working copy, or null if none could be created
        Throws:
        JavaModelException - if the contents of the working copy cannot be accessed. Reasons include:
        • The working copy does not exist (ELEMENT_DOES_NOT_EXIST)
      • getAST4

        public CompilationUnit getAST4()
                                throws JavaModelException
        Deprecated.
        JLS4 has been deprecated. This method has been replaced by getAST8() which returns an AST with JLS8 level.
        Returns a resolved AST with JLS4 level. It is created from the current state of the working copy. Creates one if none exists yet. Returns null if the current state of the working copy doesn't allow the AST to be created (e.g. if the working copy's content cannot be parsed).

        If the AST level requested during reconciling is not AST.JLS4 or if binding resolutions was not requested, then a different AST is created. Note that this AST does not become the current AST and it is only valid for the requestor.

        Returns:
        the AST created from the current state of the working copy, or null if none could be created
        Throws:
        JavaModelException - if the contents of the working copy cannot be accessed. Reasons include:
        • The working copy does not exist (ELEMENT_DOES_NOT_EXIST)
        Since:
        3.7.1
      • getAST8

        public CompilationUnit getAST8()
                                throws JavaModelException
        Deprecated.
        JLS8 has been deprecated. This method has been replaced by getAST(int) which returns an AST with the given level.
        Returns a resolved AST with JLS8 level. It is created from the current state of the working copy. Creates one if none exists yet. Returns null if the current state of the working copy doesn't allow the AST to be created (e.g. if the working copy's content cannot be parsed).

        If the AST level requested during reconciling is not AST.JLS8 or if binding resolutions was not requested, then a different AST is created. Note that this AST does not become the current AST and it is only valid for the requestor.

        Returns:
        the AST created from the current state of the working copy, or null if none could be created
        Throws:
        JavaModelException - if the contents of the working copy cannot be accessed. Reasons include:
        • The working copy does not exist (ELEMENT_DOES_NOT_EXIST)
        Since:
        3.10
      • getAST

        public CompilationUnit getAST​(int level)
                               throws JavaModelException
        Returns a resolved AST with the given AST level. It is created from the current state of the working copy. Creates one if none exists yet. Returns null if the current state of the working copy doesn't allow the AST to be created (e.g. if the working copy's content cannot be parsed).

        If the AST level requested during reconciling is not the latest available AST level or if binding resolutions was not requested, then a different AST is created. Note that this AST does not become the current AST and it is only valid for the requestor.

        Parameters:
        level - the API level; one of the .JLS* level constants declared on AST
        Returns:
        the AST created from the current state of the working copy, or null if none could be created
        Throws:
        JavaModelException - if the contents of the working copy cannot be accessed. Reasons include:
        • The working copy does not exist (ELEMENT_DOES_NOT_EXIST)
        Since:
        3.14
      • getASTLevel

        public int getASTLevel()
        Returns the AST level requested by the reconcile operation. It is either ICompilationUnit.NO_AST, or one of the JLS constants defined on AST.
        Returns:
        the AST level requested by the reconcile operation
      • isResolvingBindings

        public boolean isResolvingBindings()
        Returns whether the reconcile operation is resolving bindings.
        Returns:
        whether the reconcile operation is resolving bindings
      • getDelta

        public IJavaElementDelta getDelta()
        Returns the delta describing the change to the working copy being reconciled. Returns null if there is no change. Note that the delta's AST is not yet positioned at this stage. Use getAST4() to get the current AST.
        Returns:
        the delta describing the change, or null if none
      • getProblems

        public CategorizedProblem[] getProblems​(String markerType)
        Returns the problems to be reported to the problem requestor of the reconcile operation for the given marker type. Returns null if no problems need to be reported for this marker type.
        Parameters:
        markerType - the given marker type
        Returns:
        problems to be reported to the problem requestor
      • getWorkingCopy

        public ICompilationUnit getWorkingCopy()
        Returns the working copy this context refers to.
        Returns:
        the working copy this context refers to
      • resetAST

        public void resetAST()
        Resets the AST carried by this context. A compilation participant that modifies the environment that would result in different bindings for the AST is expected to reset the AST on this context, so that other participants don't get a stale AST.

        Note that resetting the AST will not restart the reconcile process. Only further participants will see the new AST. Thus participants running before the one that resets the AST will have a stale view of the AST and its problems. Use the compilation participant extension point to order the participants.

      • putProblems

        public void putProblems​(String markerType,
                                CategorizedProblem[] problems)
        Sets the problems to be reported to the problem requestor of the reconcile operation for the given marker type. null indicates that no problems need to be reported.

        Using this functionality, a participant that resolves problems for a given marker type can hide those problems since they don't exist any longer.

        Parameters:
        markerType - the marker type of the given problems
        problems - the problems to be reported to the problem requestor of the reconcile operation, or null if none