Module technology.sola.engine

Package technology.sola.engine.assets

Enum Class AssetExtension

java.lang.Object

java.lang.Enum<AssetExtension>

technology.sola.engine.assets.AssetExtension

All Implemented Interfaces:

Serializable, Comparable<AssetExtension>, Constable

public enum AssetExtension
extends Enum<AssetExtension>

Enumeration of support Asset file extensions.

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
JPG	The "jpg" SolaImage file extension.
JSON	The "json" JsonElementAsset file extension.
MP3	The "mp3" AudioClip file extension.
PNG	The "png" SolaImage file extension.
WAV	The "wav" AudioClip file extension.

Method Summary

Modifier and Type	Method	Description
static void	assertExtension(AssetExtension extension, AssetExtension... assetExtensions)	Asserts that a file has a given extension.
static void	assertPathExtension(String path, AssetExtension... assetExtensions)	Asserts that a file has a given extension.
static AssetExtension	fromPath(String path)	Gets the AssetExtension from a file path.
static AssetExtension	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AssetExtension[]	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

JPG

public static final AssetExtension JPG

The "jpg" SolaImage file extension.

JSON

public static final AssetExtension JSON

The "json" JsonElementAsset file extension.

MP3

public static final AssetExtension MP3

The "mp3" AudioClip file extension.

PNG

public static final AssetExtension PNG

The "png" SolaImage file extension.

WAV

public static final AssetExtension WAV

The "wav" AudioClip file extension.

Method Details

values

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

fromPath

public static AssetExtension fromPath(String path)

Gets the AssetExtension from a file path. Throws IllegalArgumentException if the extension is not supported.

Parameters:

path - the file path

Returns:

the AssetExtension for the file path

assertPathExtension

public static void assertPathExtension(String path,
 AssetExtension... assetExtensions)

Asserts that a file has a given extension.

Parameters:

path - the path for the file

assetExtensions - the valid assetExtensions for the file

assertExtension

public static void assertExtension(AssetExtension extension,
 AssetExtension... assetExtensions)

Asserts that a file has a given extension.

Parameters:

extension - the extension to test

assetExtensions - the valid assetExtensions for the file