- java.lang.Object
-
- java.lang.Enum<FilenameExtension>
-
- org.refcodes.data.FilenameExtension
-
- All Implemented Interfaces:
Serializable
,Comparable<FilenameExtension>
,org.refcodes.mixin.FilenameExtensionAccessor
,org.refcodes.mixin.FilenameSuffixAccessor
public enum FilenameExtension extends Enum<FilenameExtension> implements org.refcodes.mixin.FilenameExtensionAccessor, org.refcodes.mixin.FilenameSuffixAccessor
TheFilenameExtension
define values useful when working with files or a file-system.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.refcodes.mixin.FilenameExtensionAccessor
org.refcodes.mixin.FilenameExtensionAccessor.FilenameExtensionBuilder<B extends org.refcodes.mixin.FilenameExtensionAccessor.FilenameExtensionBuilder<B>>, org.refcodes.mixin.FilenameExtensionAccessor.FilenameExtensionMutator, org.refcodes.mixin.FilenameExtensionAccessor.FilenameExtensionProperty
-
Nested classes/interfaces inherited from interface org.refcodes.mixin.FilenameSuffixAccessor
org.refcodes.mixin.FilenameSuffixAccessor.FilenameSuffixBuilder<B extends org.refcodes.mixin.FilenameSuffixAccessor.FilenameSuffixBuilder<B>>, org.refcodes.mixin.FilenameSuffixAccessor.FilenameSuffixMutator, org.refcodes.mixin.FilenameSuffixAccessor.FilenameSuffixProperty
-
-
Enum Constant Summary
Enum Constants Enum Constant Description BACKUP
BASE64
BASE64 encoded data.BMP
CHAOS
Chaos encrypted encoded data.CHAOS64
Chaos encrypted and base 64 encoded data.CIPHER_VERSION
The file suffix used for files containing a single cipher version.CSV
GIF
GZIP
INI
Windows configuration filename extension.JAR
JPG
JSON
PNG
PROPERTIES
SH
TAR
TAR_GZIP
TEMP
TIFF
TOML
TXT
XML
YAML
ZIP
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getFilenameExtension()
Retrieves the filename extension.String
getFilenameSuffix()
A filename suffix included the prefixed dot (".") of the file name filename extension.static FilenameExtension
toFileNameExtension(String aFilename)
Determines the filename'sFilenameExtension
definition.static String
toRawFileNameExtension(String aFilename)
Determines the filename's extension.static FilenameExtension
valueOf(String name)
Returns the enum constant of this type with the specified name.static FilenameExtension[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
TEMP
public static final FilenameExtension TEMP
-
BACKUP
public static final FilenameExtension BACKUP
-
TAR
public static final FilenameExtension TAR
-
GZIP
public static final FilenameExtension GZIP
-
TAR_GZIP
public static final FilenameExtension TAR_GZIP
-
CSV
public static final FilenameExtension CSV
-
TXT
public static final FilenameExtension TXT
-
JAR
public static final FilenameExtension JAR
-
ZIP
public static final FilenameExtension ZIP
-
SH
public static final FilenameExtension SH
-
CIPHER_VERSION
public static final FilenameExtension CIPHER_VERSION
The file suffix used for files containing a single cipher version.
-
PROPERTIES
public static final FilenameExtension PROPERTIES
-
JSON
public static final FilenameExtension JSON
-
TOML
public static final FilenameExtension TOML
-
YAML
public static final FilenameExtension YAML
-
XML
public static final FilenameExtension XML
-
INI
public static final FilenameExtension INI
Windows configuration filename extension.
-
BASE64
public static final FilenameExtension BASE64
BASE64 encoded data.
-
CHAOS64
public static final FilenameExtension CHAOS64
Chaos encrypted and base 64 encoded data.
-
CHAOS
public static final FilenameExtension CHAOS
Chaos encrypted encoded data.
-
TIFF
public static final FilenameExtension TIFF
-
GIF
public static final FilenameExtension GIF
-
PNG
public static final FilenameExtension PNG
-
BMP
public static final FilenameExtension BMP
-
JPG
public static final FilenameExtension JPG
-
-
Method Detail
-
values
public static FilenameExtension[] 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 (FilenameExtension c : FilenameExtension.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static FilenameExtension valueOf(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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- 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 interfaceorg.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 interfaceorg.refcodes.mixin.FilenameExtensionAccessor
- Returns:
- The filename extension stored by the filename extension property.
-
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'sFilenameExtension
definition.- Parameters:
aFilename
- The filename for which to determine theFilenameExtension
.- Returns:
- The
FilenameExtension
or null if it has none extension.
-
-