Package io.wcm.handler.media

Enum MediaInvalidReason

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<MediaInvalidReason>
    public enum MediaInvalidReason
extends java.lang.Enum<MediaInvalidReason>
    Reasons while a media request could not be resolved.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CUSTOM
      Media is invalid due to a check from a pre- or post processor.
      INVALID_MEDIA_FORMAT
      One or all of the given media format names are invalid.
      MEDIA_REFERENCE_INVALID
      Media item not found: that means the media request path is invalid or the user has no read access.
      MEDIA_REFERENCE_MISSING
      The media request was empty.
      NO_MATCHING_RENDITION
      No matching rendition: The media item exists, but no rendition matches for the requested media args.
      NOT_ENOUGH_MATCHING_RENDITIONS
      Not enough matching renditions: The media item exists and some renditions could be resolved, but not for all mandatory media formats requested.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static MediaInvalidReason valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static MediaInvalidReason[] 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

      • MEDIA_REFERENCE_MISSING

        public static final MediaInvalidReason MEDIA_REFERENCE_MISSING
        The media request was empty.

      • MEDIA_REFERENCE_INVALID

        public static final MediaInvalidReason MEDIA_REFERENCE_INVALID
        Media item not found: that means the media request path is invalid or the user has no read access.

      • NO_MATCHING_RENDITION

        public static final MediaInvalidReason NO_MATCHING_RENDITION
        No matching rendition: The media item exists, but no rendition matches for the requested media args.

      • NOT_ENOUGH_MATCHING_RENDITIONS

        public static final MediaInvalidReason NOT_ENOUGH_MATCHING_RENDITIONS
        Not enough matching renditions: The media item exists and some renditions could be resolved, but not for all mandatory media formats requested.

      • INVALID_MEDIA_FORMAT

        public static final MediaInvalidReason INVALID_MEDIA_FORMAT
        One or all of the given media format names are invalid.

    • Method Detail

      • values

        public static MediaInvalidReason[] 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 (MediaInvalidReason c : MediaInvalidReason.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static MediaInvalidReason 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