Package org.eclipse.lsp4j.jsonrpc.services

Annotation Type JsonNotification

  • @Retention(RUNTIME)
@Target(METHOD)
public @interface JsonNotification
    Annotation to mark a notification method on an interface or class.

    A notification method must be of type void and have zero or one argument.

    According to jsonrpc an argument must be an 'object' (a java bean, not e,g. String).

    The name of the jsonrpc notification will be the optional segment, followed by the name of the Java method that is annotated with JsonNotification. The name of the jsonrpc notification can be customized by using the value() field of this annotation. To specify the whole name, including the segment, in the value, set useSegment() to false.

    See Also:
    JsonSegment

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean useSegment
      When using segments, useSegment will be true to prepend the segment name to the name of the request.
      java.lang.String value
      The name of the the jsonrpc request method.

    • Element Detail

      • value

        java.lang.String value
        The name of the the jsonrpc request method. If empty, uses the name of the annotated method.
        Default:
        ""

      • useSegment

        boolean useSegment
        When using segments, useSegment will be true to prepend the segment name to the name of the request.
        See Also:
        JsonSegment
        Default:
        true