org.netbeans.api.java.source.ui

Class ElementOpen

java.lang.Object

org.netbeans.api.java.source.ui.ElementOpen

public final class ElementOpen
extends Object

Utility class for opening elements in editor.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ElementOpen.Location Represents the location of an element.

Method Summary

Modifier and Type	Method and Description
static CompletableFuture<ElementOpen.Location>	getLocation(ClasspathInfo cpInfo, ElementHandle<? extends Element> el, String resourceName) Gets location of the Element corresponding to the given ElementHandle.
static CompletableFuture<ElementOpen.Location>	getLocation(ClasspathInfo cpInfo, ElementHandle<? extends Element> el, String resourceName, String... names) Gets location of the Element corresponding to the given ElementHandle.
static boolean	open(ClasspathInfo cpInfo, Element el) Opens given Element.
static boolean	open(ClasspathInfo cpInfo, ElementHandle<? extends Element> el) Opens Element corresponding to the given ElementHandle.
static boolean	open(ClasspathInfo cpInfo, ElementHandle<? extends Element> el, String... names) Opens Element corresponding to the given ElementHandle.
static boolean	open(FileObject toSearch, ElementHandle<? extends Element> toOpen) Opens given Element.
static boolean	open(FileObject toSearch, TreePathHandle toOpen) Opens given TreePathHandle.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

open

public static boolean open(ClasspathInfo cpInfo,
                           ElementHandle<? extends Element> el)

Opens Element corresponding to the given ElementHandle.

Parameters:

cpInfo - ClasspathInfo which should be used for the search

el - declaration to open

Returns:

true if and only if the declaration was correctly opened, false otherwise

Since:

1.5

open

public static boolean open(ClasspathInfo cpInfo,
                           ElementHandle<? extends Element> el,
                           String... names)

Opens Element corresponding to the given ElementHandle.

Parameters:

cpInfo - ClasspathInfo which should be used for the search

el - declaration to open

names - suggested names for the file to search for

Returns:

true if and only if the declaration was correctly opened, false otherwise

Since:

1.67

open

public static boolean open(ClasspathInfo cpInfo,
                           Element el)

Opens given Element.

Parameters:

cpInfo - ClasspathInfo which should be used for the search

el - declaration to open

Returns:

true if and only if the declaration was correctly opened, false otherwise

open

public static boolean open(@NonNull
                           FileObject toSearch,
                           @NonNull
                           ElementHandle<? extends Element> toOpen)

Opens given Element.

Parameters:

toSearch - fileobject whose ClasspathInfo will be used

toOpen - ElementHandle of the element which should be opened.

Returns:

true if and only if the declaration was correctly opened, false otherwise

open

public static boolean open(@NonNull
                           FileObject toSearch,
                           @NonNull
                           TreePathHandle toOpen)

Opens given TreePathHandle.

Parameters:

toSearch - the FileObject used to resolve the TreePathHandle in

toOpen - TreePathHandle of the Tree which should be opened.

Returns:

true if and only if the declaration was correctly opened, false otherwise

Since:

1.45

getLocation

public static CompletableFuture<ElementOpen.Location> getLocation(ClasspathInfo cpInfo,
                                                                  ElementHandle<? extends Element> el,
                                                                  String resourceName)

Gets location of the Element corresponding to the given ElementHandle.

Parameters:

cpInfo - ClasspathInfo which should be used for the search

el - ElementHandle to search

resourceName - optional resource name to search

Returns:

location of the given element

Since:

1.58

getLocation

public static CompletableFuture<ElementOpen.Location> getLocation(ClasspathInfo cpInfo,
                                                                  ElementHandle<? extends Element> el,
                                                                  String resourceName,
                                                                  String... names)

Gets location of the Element corresponding to the given ElementHandle.

Parameters:

cpInfo - ClasspathInfo which should be used for the search

el - ElementHandle to search

resourceName - optional resource name to search

names - suggested names of the source file to seek for

Returns:

location of the given element

Since:

1.67