Package org.incendo.cloud.caption

Interface Caption

@Immutable @API(status=STABLE) public interface Caption
This is a reference to a caption and does not contain any message itself.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull String
    key()
    Returns the caption key.
    static @NonNull Caption
    of(@NonNull String key)
    Creates a new caption with a given key

  • Method Details

    • of

      static @NonNull Caption of(@NonNull String key)
      Creates a new caption with a given key
      Parameters:
      key - the caption key
      Returns:
      the created caption

    • key

      @NonNull String key()
      Returns the caption key.
      Returns:
      the caption key