org.netbeans.spi.lsp

Interface SignatureInformationCollector

@MimeLocation(subfolderName="SignatureHelpProviders")
public interface SignatureInformationCollector

Interface for computing and collecting signature information. Clients can use this interface to collect signature information and send them for presentation outside of NetBeans using the Language Server Protocol. Implementations of the interface should be registered in MimeLookup.

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

Since:

1.20

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SignatureInformationCollector.Builder Builder for SignatureInformation instances.

Method Summary

Modifier and Type	Method and Description
void	collectSignatureInformation(Document doc, int offset, SignatureInformation.Context context, java.util.function.Consumer<SignatureInformation> consumer) Computes and collects signature information for a document at a given offset.
static SignatureInformationCollector.Builder	newBuilder(String label, boolean isActive) Creates a builder for SignatureInformation instances.

Method Detail

collectSignatureInformation

void collectSignatureInformation(@NonNull
                                 Document doc,
                                 int offset,
                                 @NullAllowed
                                 SignatureInformation.Context context,
                                 @NonNull
                                 java.util.function.Consumer<SignatureInformation> consumer)

Computes and collects signature information for a document at a given offset.

Parameters:

doc - a text document

offset - an offset inside the text document

context - an optional signature help context

consumer - an operation accepting collected signature information

Since:

1.0

newBuilder

static SignatureInformationCollector.Builder newBuilder(@NonNull
                                                        String label,
                                                        boolean isActive)

Creates a builder for SignatureInformation instances.

Parameters:

label - the label of the signature information

isActive - true if the signature is active

Returns:

newly created builder

Since:

1.20