Interface PromptOperationTagState


@Experimental public interface PromptOperationTagState
Descriptor for the current state of the tag on a specific operation.
Since:
5.2.241209
  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable Boolean
    Returns any inherited selection state of the tag.
    @Nullable Boolean
    Returns any local non-inherited selection state of the tag.
    Returns the source in which the tag has been initially configured, if known.
    @NotNull String
    Returns the tag name.
    default boolean
    Returns whether the tag is active for the related context.
    boolean
    Returns whether this tag is a default one.
  • Method Details

    • getTag

      @NotNull @NotNull String getTag()
      Returns the tag name.
      Returns:
      The name of the tag.
      Since:
      5.2.241209
    • getLocal

      @Nullable @Nullable Boolean getLocal()
      Returns any local non-inherited selection state of the tag.
      Returns:
      The local selection state, or null if not specified explicitly.
      Since:
      5.2.241209
    • getInherited

      @Nullable @Nullable Boolean getInherited()
      Returns any inherited selection state of the tag.
      Returns:
      The inherited selection state, or null for no inherited state.
      Since:
      5.2.241209
    • isActive

      default boolean isActive()
      Returns whether the tag is active for the related context.
      Returns:
      true if the tag is active, false otherwise.
      Since:
      5.2.241209
    • getSource

      @NotNull @NotNull PromptSourceType getSource()
      Returns the source in which the tag has been initially configured, if known.
      Returns:
      The initial source of the tag.
      Since:
      5.2.241209
    • isDefault

      boolean isDefault()
      Returns whether this tag is a default one.
      Returns:
      true for a default tag (e.g. "ContentAssistant"), false for a custom tag.
      Since:
      5.2.241209