Class SharedASTProvider


  • @Deprecated
    public final class SharedASTProvider
    extends Object
    Deprecated.
    The SharedASTProvider provides access to the AST root used by the current active Java editor.

    For performance reasons, not more than one AST should be kept in memory at a time. Therefore, clients must not keep any references to the shared AST or its nodes or bindings.

    Clients can make the following assumptions about the AST:

    It is possible that in the future a higher API level is used, or that future options will be enabled.

    The returned AST is shared. It is marked as ASTNode.PROTECT and must not be modified. Clients are advised to use the non-modifying ASTRewrite to get update scripts.

    This class is not intended to be subclassed or instantiated by clients.

    Since:
    3.4
    Restriction:
    This class is not intended to be instantiated by clients.
    • Field Detail

      • WAIT_YES

        public static final SharedASTProvider.WAIT_FLAG WAIT_YES
        Deprecated.
        Wait flag indicating that a client requesting an AST wants to wait until an AST is ready.

        An AST will be created by this AST provider if the shared AST is not for the given Java element.

      • WAIT_ACTIVE_ONLY

        public static final SharedASTProvider.WAIT_FLAG WAIT_ACTIVE_ONLY
        Deprecated.
        Wait flag indicating that a client requesting an AST only wants to wait for the shared AST of the active editor.

        No AST will be created by the AST provider.

      • WAIT_NO

        public static final SharedASTProvider.WAIT_FLAG WAIT_NO
        Deprecated.
        Wait flag indicating that a client requesting an AST only wants the already available shared AST.

        No AST will be created by the AST provider.

    • Method Detail

      • getAST

        public static CompilationUnit getAST​(ITypeRoot element,
                                             SharedASTProvider.WAIT_FLAG waitFlag,
                                             IProgressMonitor progressMonitor)
        Deprecated.
        Returns a compilation unit AST for the given Java element. If the element is the input of the active Java editor, the AST is the shared AST.

        Clients are not allowed to modify the AST and must not keep any references.

        Parameters:
        element - the ITypeRoot, must not be null
        waitFlag - WAIT_YES, WAIT_NO or WAIT_ACTIVE_ONLY
        progressMonitor - the progress monitor or null
        Returns:
        the AST or null.
        • If WAIT_NO has been specified null is returned if the element is not input of the current Java editor or no AST is available
        • If WAIT_ACTIVE_ONLY has been specified null is returned if the element is not input of the current Java editor
        • If WAIT_YES has been specified either the shared AST is returned or a new AST is created.
        • null will be returned if the operation gets canceled.