Package com.iizix.image

Enum Class ImageType

java.lang.Object
java.lang.Enum<ImageType>
com.iizix.image.ImageType
All Implemented Interfaces:
Serializable, Comparable<ImageType>, Constable
public enum ImageType extends Enum<ImageType>
The image selected by a user type enumeration. The APNG, JPEG2000 and HEIC/HEIF image file formats are not supported.
Author:
Christopher Mindus

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ALL_IMAGES
    The ALL_IMAGES image type has the media type "image/*", and the file extension set to "*".
    BMP
    BMP: "image/bmp", extension ".bmp".
    GIF
    GIF: "image/gif", extension ".gif".
    JPEG
    JPEG: "image/jpeg", extensions ".jpg,.jpeg,.jpe,.jif,.jfif,.jfi".
    PNG
    PNG: "image/png", extension ".png" (no support for "Animated PNG" a.k.a.
    SVG
    SVG: "image/svg+xml", extension ".svg" or GZip compressed (much like ".svg.gz") ".svgz".
    TIFF
    TIFF: "image/tiff", extensions ".tif,.tiff".
    UNKNOWN
    Unknown or currently unsupported image type, Strings for media type and extension are null.
    WBMP
    WBMP: "image/vnd.wap.wbmp", extension ".wbmp".
    WEBP
    WebP: "media/webp", extension ".webp".

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final String
    extensions
    The common file extensions for this image media type, in lower case.
    final Set<String>
    extensionsNoDot
    The file extensions without leading "dot" as an unmodifiable collection.
    final String
    firstExtension
    The first and most common file extension starting with '.' if not ALL_IMAGES otherwise '*' for {link #ALL_IMAGES} or null for UNKNOWN.
    final boolean
    isBitmap
    Flag for bitmap type (valid and non-vector formats except ALL_IMAGES is true).
    final boolean
    isValidExtension
    Flag for defined image type, i.e.
    final String
    mediaType
    The media type, or null for {@link #UNKNOWN}.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ImageType
    fromExtension(String extension)
    Finds the image type for a file extension.
    static ImageType
    fromMediaType(String mediaType)
    Finds the image type from the "image/..." string.
    static ImageType
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ImageType[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • UNKNOWN

      public static final ImageType UNKNOWN
      Unknown or currently unsupported image type, Strings for media type and extension are null.

    • ALL_IMAGES

      public static final ImageType ALL_IMAGES
      The ALL_IMAGES image type has the media type "image/*", and the file extension set to "*".

    • PNG

      public static final ImageType PNG
      PNG: "image/png", extension ".png" (no support for "Animated PNG" a.k.a. "APNG" with file extension ".apng").

    • JPEG

      public static final ImageType JPEG
      JPEG: "image/jpeg", extensions ".jpg,.jpeg,.jpe,.jif,.jfif,.jfi".

    • GIF

      public static final ImageType GIF
      GIF: "image/gif", extension ".gif".

    • WEBP

      public static final ImageType WEBP
      WebP: "media/webp", extension ".webp".

    • TIFF

      public static final ImageType TIFF
      TIFF: "image/tiff", extensions ".tif,.tiff".

    • BMP

      public static final ImageType BMP
      BMP: "image/bmp", extension ".bmp".

    • WBMP

      public static final ImageType WBMP
      WBMP: "image/vnd.wap.wbmp", extension ".wbmp".

    • SVG

      public static final ImageType SVG
      SVG: "image/svg+xml", extension ".svg" or GZip compressed (much like ".svg.gz") ".svgz".

  • Field Details

    • isValidExtension

      public final boolean isValidExtension
      Flag for defined image type, i.e. not {@link #UNKNOWN} or {@link #ALL_IMAGES}.

    • mediaType

      public final String mediaType
      The media type, or null for {@link #UNKNOWN}.

    • extensions

      public final String extensions
      The common file extensions for this image media type, in lower case.

      It is a comma separated string of file extensions, including the "dot".

      It is "*" for {@link #ALL_IMAGES} image media type.

      It is null for {@link #UNKNOWN} image media type.

    • firstExtension

      public final String firstExtension
      The first and most common file extension starting with '.' if not ALL_IMAGES otherwise '*' for {link #ALL_IMAGES} or null for UNKNOWN.

    • extensionsNoDot

      public final Set<String> extensionsNoDot
      The file extensions without leading "dot" as an unmodifiable collection. Note: the ordering of the original extensions is kept.

    • isBitmap

      public final boolean isBitmap
      Flag for bitmap type (valid and non-vector formats except ALL_IMAGES is true).

  • Method Details

    • values

      public static ImageType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ImageType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • fromExtension

      public static ImageType fromExtension(String extension)
      Finds the image type for a file extension.
      Parameters:
      extension - File extension with or without a dot, case insensitive.
      Returns:
      The media type, or null if not found. Note that {@link #ALL_IMAGES} is returned if the extension is equal to "*" (asterisk) or ".*" (dot-asterisk).

    • fromMediaType

      public static ImageType fromMediaType(String mediaType)
      Finds the image type from the "image/..." string.
      Parameters:
      mediaType - The media type (case sensitive).
      Returns:
      The media type, or null if not found. Note that {@link #ALL_IMAGES} is returned if the mediaType is equal to "image/*".