Enum Class FilenameExtension

java.lang.Object
java.lang.Enum<FilenameExtension>
org.refcodes.data.FilenameExtension
All Implemented Interfaces:
Serializable, Comparable<FilenameExtension>, Constable, org.refcodes.mixin.FilenameExtensionAccessor, org.refcodes.mixin.FilenameSuffixAccessor
public enum FilenameExtension extends Enum<FilenameExtension> implements org.refcodes.mixin.FilenameExtensionAccessor, org.refcodes.mixin.FilenameSuffixAccessor
The FilenameExtension define values useful when working with files or a file-system.

  • Enum Constant Details

  • Method Details

    • values

      public static FilenameExtension[] 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 FilenameExtension 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

    • getFilenameSuffix

      public String getFilenameSuffix()
      A filename suffix included the prefixed dot (".") of the file name filename extension. Gets the extension with a prefixed dot (".") for directly appending it to a base filename.
      Specified by:
      getFilenameSuffix in interface org.refcodes.mixin.FilenameSuffixAccessor
      Returns:
      the extension including a prefixed dot (".");

    • getFilenameExtension

      public String getFilenameExtension()
      Retrieves the filename extension. A filename extensions does not(!) contain the dot "." separating the extension from the name, e.g. "ini" (instead of ".ini").
      Specified by:
      getFilenameExtension in interface org.refcodes.mixin.FilenameExtensionAccessor
      Returns:
      The filename extension stored by the filename extension property.

    • hasFilenameExtension

      public boolean hasFilenameExtension(Path aPath)
      Determines if the given Path denotes a file with the given format according file suffix.
      Parameters:
      aPath - The path to check
      Returns:
      True if the path denotes a file of the given format

    • hasFilenameExtension

      public boolean hasFilenameExtension(String aFileName)
      Determines if the given path denotes a file with the given format according file suffix.
      Parameters:
      aFileName - The path to check
      Returns:
      True if the path denotes a file of the given format

    • toRawFileNameExtension

      public static String toRawFileNameExtension(String aFilename)
      Determines the filename's extension.
      Parameters:
      aFilename - The filename for which to determine the filename extension.
      Returns:
      The filename extension or null if it has none extension.

    • toFileNameExtension

      public static FilenameExtension toFileNameExtension(String aFilename)
      Determines the filename's FilenameExtension definition.
      Parameters:
      aFilename - The filename for which to determine the FilenameExtension.
      Returns:
      The FilenameExtension or null if it has none extension.

    • toFileNameExtension

      public static FilenameExtension toFileNameExtension(Path aPath)
      Determines the filename's FilenameExtension definition.
      Parameters:
      aPath - The Path denoting the filename for which to determine the FilenameExtension.
      Returns:
      The FilenameExtension or null if it has none extension.