Package nl.pim16aap2.animatedarchitecture.core.audio

Class AudioConfigurator

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.audio.AudioConfigurator

All Implemented Interfaces:

IDebuggable, IRestartable

public final class AudioConfigurator
extends Object
implements IRestartable, IDebuggable

Represents a class used to read and access the audio configuration.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_DEFAULT

Method Summary

Modifier and Type	Method	Description
AudioSet	getAudioSet(StructureType structureType)	Retrieves the audio set mapped for a structure.
String	getDebugInformation()	Gets the debug information for this object.
void	initialize()	Handles the initialization.
void	shutDown()	Handles a shutdown.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

KEY_DEFAULT

public static final String KEY_DEFAULT

See Also:

• Constant Field Values

Method Details

getAudioSet

public AudioSet getAudioSet(StructureType structureType)

Retrieves the audio set mapped for a structure.

This method will use the user-specified configuration for retrieving the mapping. If the user did not modify this, the mapping is simply the same as the structure type's default audio set.

Parameters:

structureType - The type of the structure for which to retrieve the audio set to use.

Returns:

The audio set mapped for the given structure.

initialize

public void initialize()

Description copied from interface: IRestartable

Handles the initialization.

Specified by:

initialize in interface IRestartable

shutDown

public void shutDown()

Description copied from interface: IRestartable

Handles a shutdown.

Specified by:

shutDown in interface IRestartable

getDebugInformation

public String getDebugInformation()

Description copied from interface: IDebuggable

Gets the debug information for this object.

Specified by:

getDebugInformation in interface IDebuggable

Returns:

The debug information or null if there's nothing to log at this time.