Constructor Detail

Method Detail

• text

   final Optional<TextOverlay> text()

• image

   final Optional<ImageOverlay> image()

• video

   final Optional<VideoOverlay> video()

• subtitle

   final Optional<SubtitleOverlay> subtitle()

• solidColor

   final Optional<SolidColorOverlay> solidColor()

• isText

   final Boolean isText()

• isImage

   final Boolean isImage()

• isVideo

   final Boolean isVideo()

• isSubtitle

   final Boolean isSubtitle()

• isSolidColor

   final Boolean isSolidColor()

• asText

   final TextOverlay asText()

• asImage

   final ImageOverlay asImage()

• asVideo

   final VideoOverlay asVideo()

• asSubtitle

   final SubtitleOverlay asSubtitle()

• asSolidColor

   final SolidColorOverlay asSolidColor()

• _json

   final Optional<JsonValue> _json()

• accept

   final <T extends Any> T accept(Overlay.Visitor<T> visitor)

  Maps this instance's current variant to a value of type T using the given visitor.

  Note that this method is not forwards compatible with new variants from the API, unless visitor overrides Visitor.unknown. To handle variants not known to this version of the SDK gracefully, consider overriding Visitor.unknown:

  import io.imagekit.core.JsonValue;
  import java.util.Optional;
  
  Optional<String> result = overlay.accept(new Overlay.Visitor<Optional<String>>() {
      @Override
      public Optional<String> visitText(TextOverlay text) {
          return Optional.of(text.toString());
      }
  
      // ...
  
      @Override
      public Optional<String> unknown(JsonValue json) {
          // Or inspect the `json`.
          return Optional.empty();
      }
  });

• validate

   final Overlay validate()

  Validates that the types of all values in this object match their expected types recursively.

  This method is not forwards compatible with new types from the API for existing fields.

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• ofText

   final static Overlay ofText(TextOverlay text)

• ofImage

   final static Overlay ofImage(ImageOverlay image)

• ofVideo

   final static Overlay ofVideo(VideoOverlay video)

• ofSubtitle

   final static Overlay ofSubtitle(SubtitleOverlay subtitle)

• ofSolidColor

   final static Overlay ofSolidColor(SolidColorOverlay solidColor)