org.netbeans.api.java.source.ui

Class ElementHeaders

java.lang.Object

org.netbeans.api.java.source.ui.ElementHeaders

public final class ElementHeaders
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANNOTATIONS
static String	EXTENDS
static String	FLAGS
static String	IMPLEMENTS
static String	NAME
static String	PARAMETERS
static String	THROWS
static String	TYPE
static String	TYPEPARAMETERS

Method Summary

Modifier and Type	Method and Description
static StructureElement	convertElement(CompilationInfo info, Element el, ElementUtilities.ElementAcceptor childAcceptor, boolean allowBinary) Describes a javac Element as LSP StructureElement.
static int	getDistance(String s, String t) Computes distance between strings
static String	getHeader(Element element, CompilationInfo info, String formatString) Formats header of an element.
static String	getHeader(TreePath treePath, CompilationInfo info, String formatString) Formats header of a tree.
static StructureElement.Kind	javaKind2Structure(Element el) Converts Javac ElementKind to a suitable LSP structure kind.
static CompletableFuture<StructureElement>	resolveStructureElement(CompilationInfo info, Element el, boolean resolveSources) Converts a javac Element into LSP StructureElement.
static StructureElement	toStructureElement(CompilationInfo info, Element el, ElementUtilities.ElementAcceptor childAcceptor) Converts an javac Element into LSP StructureElement.

Methods inherited from class java.lang.Object

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

Field Detail

ANNOTATIONS

public static final String ANNOTATIONS

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

THROWS

public static final String THROWS

See Also:

Constant Field Values

IMPLEMENTS

public static final String IMPLEMENTS

See Also:

Constant Field Values

EXTENDS

public static final String EXTENDS

See Also:

Constant Field Values

TYPEPARAMETERS

public static final String TYPEPARAMETERS

See Also:

Constant Field Values

FLAGS

public static final String FLAGS

See Also:

Constant Field Values

PARAMETERS

public static final String PARAMETERS

See Also:

Constant Field Values

Method Detail

getHeader

public static String getHeader(TreePath treePath,
                               CompilationInfo info,
                               String formatString)

Formats header of a tree. The tree must represent an element e.g. type method, field, ...
example of formatString: "method " + NAME + PARAMETERS + " has return type " + TYPE

Parameters:

treePath - TreePath to the tree header is required for

info - CompilationInfo

formatString - Formating string

Returns:

Formated header of the tree

getHeader

public static String getHeader(Element element,
                               CompilationInfo info,
                               String formatString)

Formats header of an element.
example of formatString: "method " + NAME + PARAMETERS + " has return type " + TYPE

Parameters:

element - Element to be formated

info - Compilation info

formatString - Formating string

Returns:

Formated header of the element

getDistance

public static int getDistance(String s,
                              String t)

Computes distance between strings

Parameters:

s - First string

t - Second string

Returns:

Distance between the strings. (Number of changes which have to be done to get from s to t.

toStructureElement

@CheckForNull
public static StructureElement toStructureElement(CompilationInfo info,
                                                                Element el,
                                                                ElementUtilities.ElementAcceptor childAcceptor)

Converts an javac Element into LSP StructureElement. This method does not work for binary elements, just for elements from the parsed source. To work with non-local elements, use ElementHeaders.resolveStructureElement(org.netbeans.api.java.source.CompilationInfo, javax.lang.model.element.Element, boolean). If childAcceptor is not null, children are fetched recursively and filed into StructureElement.getChildren(); the acceptor is applied to all levels. The method returns null if the passed CompilationInfo does not contain source information for the Element.

Parameters:

info - compilation info

el - element to convert

childAcceptor - null to ignore children, non-null to filter.

Returns:

created item or null

Since:

1.63

resolveStructureElement

public static CompletableFuture<StructureElement> resolveStructureElement(CompilationInfo info,
                                                                          Element el,
                                                                          boolean resolveSources)

Converts a javac Element into LSP StructureElement. This method supports also elements that are not part of the "info" compilation. If `resolveSources' is true, it will try to acquire their relevant source, possibly using SourceJavadocAttacher API. As this process may take some time, the call may complete asynchronously when the element's source is acquired. null is returned for Elements outside that have no source associated when resolveSources is false.

Calling CompletableFuture.cancel(boolean) on the returned value performs cancel on the possible long-running task(s) in a best-effort way: it is not guaranteed that the already started processes interrupts.

Parameters:

info - compilation

el - the element to convert

resolveSources -

Returns:

completion handle for the StructureElement

Since:

1.63

convertElement

public static StructureElement convertElement(CompilationInfo info,
                                              Element el,
                                              ElementUtilities.ElementAcceptor childAcceptor,
                                              boolean allowBinary)

Describes a javac Element as LSP StructureElement. Source file and position information may not be provided, but the other fields of the StructureElement will be filled. If `allowBinaries' is true, the file member of the StructureElement may be filled with FileObject of binary that defines the Element; source FileObject is always preferred, if available.

Parameters:

info - compilation

el - the element to convert

Returns:

created item

Since:

1.64

javaKind2Structure

public static StructureElement.Kind javaKind2Structure(Element el)

Converts Javac ElementKind to a suitable LSP structure kind. Note that not all kinds are supported - such ElementKinds are converted to

Parameters:

kind -

Returns:

LSP kind suitable for DocumentSymbol - like structures.