org.netbeans.spi.lsp

Interface StructureProvider

public interface StructureProvider

Interface for building structure of symbols at a given document. Implementations of the interface should be registered in MimeLookup.

   @MimeRegistration(mimeType = "text/foo", service = StructureProvider.class)
   public class FooStructureProvider implements StructureProvider {
     ...
   }
 

Since:

1.8

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StructureProvider.Builder Builder for StructureElement instances.

Method Summary

Modifier and Type	Method and Description
static StructureProvider.Builder	copy(StructureElement from) Create builder for StructureElement instances from copy of input element.
List<StructureElement>	getStructure(Document doc) Resolves a structure tree of symbols at the given document.
static StructureProvider.Builder	newBuilder(String name, StructureElement.Kind kind) Create builder for StructureElement instances.

Method Detail

getStructure

@NonNull
List<StructureElement> getStructure(@NonNull
                                             Document doc)

Resolves a structure tree of symbols at the given document.

Parameters:

doc - document on which to operate.

Returns:

a list of top level structure elements

Since:

1.8

newBuilder

static StructureProvider.Builder newBuilder(@NonNull
                                            String name,
                                            @NonNull
                                            StructureElement.Kind kind)

Create builder for StructureElement instances.

Parameters:

name - the name of the structure element

kind - the kind of structure element

Returns:

newly created builder

Since:

1.8

copy

static StructureProvider.Builder copy(@NonNull
                                      StructureElement from)

Create builder for StructureElement instances from copy of input element.

Parameters:

from - element that is copied

Returns:

newly created builder with all attributes as input structure element