org.netbeans.spi.lsp

Class StructureProvider.Builder

java.lang.Object

org.netbeans.spi.lsp.StructureProvider.Builder

Enclosing interface:

StructureProvider

public static final class StructureProvider.Builder
extends Object

Builder for StructureElement instances.

Since:

1.8

Method Summary

Modifier and Type	Method and Description
StructureProvider.Builder	addTag(StructureElement.Tag tag) Adds tag for this structure element.
StructureElement	build() Builds structure element.
StructureProvider.Builder	children(List<StructureElement> children) Sub elements of this structure element.
StructureProvider.Builder	children(StructureElement... children) Adds sub element for this structure element.
StructureProvider.Builder	detail(String detail) The detail of StructureElement, e.g the signature of a function.
StructureProvider.Builder	expandedEndOffset(int expandedEndOffset) The expanded range is offset range that is typically used to determine if the cursors inside the element to reveal in the element in the UI.
StructureProvider.Builder	expandedStartOffset(int expandedStartOffset) The expanded range is offset range that is typically used to determine if the cursors inside the element to reveal in the element in the UI.
StructureProvider.Builder	file(FileObject f) Sets file which contains the structure element.
StructureProvider.Builder	kind(StructureElement.Kind name) Kind of this structure element.
StructureProvider.Builder	name(String name) The name of StructureElement is displayed in the structure tree and other ui.
StructureProvider.Builder	selectionEndOffset(int selectionEndOffset) The end of offset range where this element should be selected and revealed in document when selected in outline view.
StructureProvider.Builder	selectionStartOffset(int selectionStartOffset) The start of offset range where this element should be selected and revealed in document when selected in outline view.
StructureProvider.Builder	tags(Set<StructureElement.Tag> tags) Tags for this structure element.

Methods inherited from class java.lang.Object

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

Method Detail

name

@NonNull
public StructureProvider.Builder name(@NonNull
                                               String name)

The name of StructureElement is displayed in the structure tree and other ui.

Since:

1.8

kind

@NonNull
public StructureProvider.Builder kind(@NonNull
                                               StructureElement.Kind name)

Kind of this structure element.

Since:

1.8

detail

@NonNull
public StructureProvider.Builder detail(@NonNull
                                                 String detail)

The detail of StructureElement, e.g the signature of a function. If not provided only the name is used.

Since:

1.8

selectionStartOffset

@NonNull
public StructureProvider.Builder selectionStartOffset(int selectionStartOffset)

The start of offset range where this element should be selected and revealed in document when selected in outline view.

Since:

1.8

selectionEndOffset

@NonNull
public StructureProvider.Builder selectionEndOffset(int selectionEndOffset)

The end of offset range where this element should be selected and revealed in document when selected in outline view.

Since:

1.8

expandedStartOffset

@NonNull
public StructureProvider.Builder expandedStartOffset(int expandedStartOffset)

The expanded range is offset range that is typically used to determine if the cursors inside the element to reveal in the element in the UI.

Since:

1.8

expandedEndOffset

@NonNull
public StructureProvider.Builder expandedEndOffset(int expandedEndOffset)

The expanded range is offset range that is typically used to determine if the cursors inside the element to reveal in the element in the UI.

Since:

1.8

addTag

@NonNull
public StructureProvider.Builder addTag(@NonNull
                                                 StructureElement.Tag tag)

Adds tag for this structure element.

Since:

1.8

tags

@NonNull
public StructureProvider.Builder tags(@NonNull
                                               Set<StructureElement.Tag> tags)

Tags for this structure element.

Since:

1.8

children

@NonNull
public StructureProvider.Builder children(@NonNull
                                                   StructureElement... children)

Adds sub element for this structure element.

Since:

1.8

children

@NonNull
public StructureProvider.Builder children(@NonNull
                                                   List<StructureElement> children)

Sub elements of this structure element.

Since:

1.8

file

public StructureProvider.Builder file(FileObject f)

Sets file which contains the structure element. null stands for either implicit or inaccessible.

Parameters:

f - file object

Returns:

this instance

Since:

1.9

build

@NonNull
public StructureElement build()

Builds structure element.

Since:

1.8