Package io.wcm.handler.mediasource.dam

Enum AemRenditionType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<AemRenditionType>
    public enum AemRenditionType
extends java.lang.Enum<AemRenditionType>
    Defines the different types of renditions generated automatically by AEM.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      OTHER_RENDITION
      Any other rendition generated by AEM (with cq5dam. or cqdam. prefix).
      THUMBNAIL_RENDITION
      Thumbnail rendition (with cq5dam.thumbnail. prefix).
      VIDEO_RENDITION
      Video rendition (with cq5dam.video. prefix).
      WEB_RENDITION
      Web rendition for the image editor/cropping (with cq5dam.web. prefix).

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static @Nullable AemRenditionType forRendition​(@NotNull com.day.cq.dam.api.Rendition rendition)  
      static @Nullable AemRenditionType forRendition​(@NotNull java.lang.String renditionName)  
      boolean matches​(@NotNull com.day.cq.dam.api.Rendition rendition)  
      boolean matches​(@NotNull java.lang.String renditionName)  
      static AemRenditionType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static AemRenditionType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • THUMBNAIL_RENDITION

        public static final AemRenditionType THUMBNAIL_RENDITION
        Thumbnail rendition (with cq5dam.thumbnail. prefix).

      • WEB_RENDITION

        public static final AemRenditionType WEB_RENDITION
        Web rendition for the image editor/cropping (with cq5dam.web. prefix).

      • VIDEO_RENDITION

        public static final AemRenditionType VIDEO_RENDITION
        Video rendition (with cq5dam.video. prefix).

      • OTHER_RENDITION

        public static final AemRenditionType OTHER_RENDITION
        Any other rendition generated by AEM (with cq5dam. or cqdam. prefix).

    • Method Detail

      • values

        public static AemRenditionType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (AemRenditionType c : AemRenditionType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static AemRenditionType valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • matches

        public boolean matches​(@NotNull
                       @NotNull java.lang.String renditionName)
        Parameters:
        renditionName - Rendition name
        Returns:
        true if Rendition name matches with this type

      • matches

        public boolean matches​(@NotNull
                       @NotNull com.day.cq.dam.api.Rendition rendition)
        Parameters:
        rendition - Rendition
        Returns:
        true if Rendition name matches with this type

      • forRendition

        @Nullable
public static @Nullable AemRenditionType forRendition​(@NotNull
                                                      @NotNull java.lang.String renditionName)
        Parameters:
        renditionName - Rendition name
        Returns:
        Matching AEM rendition type or null if no match

      • forRendition

        @Nullable
public static @Nullable AemRenditionType forRendition​(@NotNull
                                                      @NotNull com.day.cq.dam.api.Rendition rendition)
        Parameters:
        rendition - Rendition
        Returns:
        Matching AEM rendition type or null if no match