Package jmri.implementation

Class AbstractAudio

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.implementation.AbstractAudio

All Implemented Interfaces:

java.lang.Comparable<NamedBean>, Audio, PropertyChangeProvider, NamedBean

Direct Known Subclasses:

AbstractAudioBuffer, AbstractAudioListener, AbstractAudioSource

public abstract class AbstractAudio
extends AbstractNamedBean
implements Audio

Base implementation of the Audio class.

Specific implementations will extend this base class.

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.NamedBean

NamedBean.BadNameException, NamedBean.BadSystemNameException, NamedBean.BadUserNameException, NamedBean.DisplayOptions, NamedBean.DuplicateSystemNameException

Field Summary

Fields inherited from class jmri.implementation.AbstractNamedBean

listenerRefs, mSystemName, register

Fields inherited from interface jmri.Audio

AT, BUFFER, CMD_BIND_BUFFER, CMD_FADE_IN, CMD_FADE_OUT, CMD_INIT_FACTORY, CMD_LOAD_SOUND, CMD_PAUSE, CMD_PAUSE_TOGGLE, CMD_PLAY, CMD_PLAY_TOGGLE, CMD_QUEUE_BUFFERS, CMD_RESET_POSITION, CMD_RESUME, CMD_REWIND, CMD_STOP, CMD_UNQUEUE_BUFFERS, DECIMAL_PLACES, FADE_IN, FADE_NONE, FADE_OUT, LISTENER, MAX_DISTANCE, SOURCE, STATE_EMPTY, STATE_INITIAL, STATE_LOADED, STATE_MOVING, STATE_PLAYING, STATE_POSITIONED, STATE_STOPPED, UP

Fields inherited from interface jmri.NamedBean

DISPLAY_NAME_FORMAT, INCONSISTENT, PROPERTY_STATE, QUOTED_NAME_FORMAT, UNKNOWN

Constructor Summary

Constructors

Constructor	Description
AbstractAudio(java.lang.String systemName)	Abstract constructor for new Audio with system name
AbstractAudio(java.lang.String systemName, java.lang.String userName)	Abstract constructor for new Audio with system name and user name

Method Summary

Modifier and Type	Method	Description
protected abstract void	cleanup()	Abstract method that concrete classes will implement to perform necessary cleanup routines.
void	dispose()	Deactivate this object, so that it releases as many resources as possible and no longer effects others.
java.lang.String	getBeanType()	For instances in the code where we are dealing with just a bean and a message needs to be passed to the user or in a log.
int	getState()	Provide generic access to internal state.
java.util.List<NamedBeanUsageReport>	getUsageReport(NamedBean bean)	Get a list of references for the specified bean.
static float	roundDecimal(float value)	Static method to round a float value to the number of decimal places defined by DECIMAL_PLACES.
static float	roundDecimal(float value, double places)	Static method to round a float value to the specified number of decimal places
void	setState(int newState)	Provide generic access to internal state.

Methods inherited from class jmri.implementation.AbstractNamedBean

addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, describeState, equals, firePropertyChange, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUserName, hashCode, removeProperty, removePropertyChangeListener, removePropertyChangeListener, setComment, setProperty, setUserName, toString, toStringSuffix, updateListenerRef, vetoableChange

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jmri.Audio

getSubType, stateChanged

Methods inherited from interface jmri.NamedBean

addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, compareTo, describeState, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListenersByReference, getPropertyKeys, getRecommendedToolTip, getSystemName, getUserName, removeProperty, setComment, setProperty, setUserName, toString, updateListenerRef, vetoableChange

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Constructor Detail

AbstractAudio

public AbstractAudio(java.lang.String systemName)

Abstract constructor for new Audio with system name

Parameters:

systemName - Audio object system name (e.g. IAS1, IAB4)

AbstractAudio

public AbstractAudio(java.lang.String systemName,
                     java.lang.String userName)

Abstract constructor for new Audio with system name and user name

Parameters:

systemName - Audio object system name (e.g. IAS1, IAB4)

userName - Audio object user name

Method Detail

getState

public int getState()

Description copied from interface: NamedBean

Provide generic access to internal state.

This generally shouldn't be used by Java code; use the class-specific form instead (e.g. getCommandedState in Turnout). This is provided to make scripts easier to read.

Specified by:

getState in interface NamedBean

Returns:

the state

setState

public void setState(int newState)

Description copied from interface: NamedBean

Provide generic access to internal state.

This generally shouldn't be used by Java code; use the class-specific form instead (e.g. setCommandedState in Turnout). This is provided to make scripts access easier to read.

Specified by:

setState in interface NamedBean

Parameters:

newState - the state

cleanup

protected abstract void cleanup()

Abstract method that concrete classes will implement to perform necessary cleanup routines.

This method is now included in dispose(). The caller can call dispose() to cleanup and deregister an audio object.

dispose

public void dispose()

Description copied from class: AbstractNamedBean

Deactivate this object, so that it releases as many resources as possible and no longer effects others.

For example, if this object has listeners, after a call to this method it should no longer notify those listeners. Any native or system-wide resources it maintains should be released, including threads, files, etc.

It is an error to invoke any other methods on this object once dispose() has been called. Note, however, that there is no guarantee about behavior in that case.

Afterwards, references to this object may still exist elsewhere, preventing its garbage collection. But it's formally dead, and shouldn't be keeping any other objects alive. Therefore, this method should null out any references to other objects that this NamedBean contained.

Specified by:

dispose in interface NamedBean

Overrides:

dispose in class AbstractNamedBean

roundDecimal

public static float roundDecimal(float value,
                                 double places)

Static method to round a float value to the specified number of decimal places

Parameters:

value - float value to round

places - number of decimal places to round to

Returns:

float value rounded to specified number of decimal places

roundDecimal

public static float roundDecimal(float value)

Static method to round a float value to the number of decimal places defined by DECIMAL_PLACES.

Parameters:

value - float value to round

Returns:

float value rounded to DECIMAL_PLACES decimal places

getBeanType

public java.lang.String getBeanType()

Description copied from interface: NamedBean

For instances in the code where we are dealing with just a bean and a message needs to be passed to the user or in a log.

Specified by:

getBeanType in interface NamedBean

Returns:

a string of the bean type, eg Turnout, Sensor etc

getUsageReport

public java.util.List<NamedBeanUsageReport> getUsageReport(NamedBean bean)

Get a list of references for the specified bean.

Specified by:

getUsageReport in interface NamedBean

Parameters:

bean - The bean to be checked.

Returns:

a list of NamedBeanUsageReports or an empty ArrayList.