Package jmri.implementation

Class AbstractMemory

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.implementation.AbstractMemory

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultMemory

public abstract class AbstractMemory
extends AbstractNamedBean
implements Memory

Base for the Memory interface.

Implements the parameter binding support.

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.NamedBean

DISPLAY_NAME_FORMAT, INCONSISTENT, PROPERTY_STATE, QUOTED_NAME_FORMAT, UNKNOWN

Constructor Summary

Constructors

Constructor	Description
AbstractMemory(java.lang.String systemName)
AbstractMemory(java.lang.String systemName, java.lang.String userName)

Method Summary

Modifier and Type	Method	Description
int	compareSystemNameSuffix(java.lang.String suffix1, java.lang.String suffix2, NamedBean n)	Compare the suffix of this NamedBean's name with the suffix of the argument NamedBean's name for the NamedBean.compareTo(jmri.NamedBean) operation.
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.
java.lang.Object	getValue()	Get the stored value.
void	setValue(java.lang.Object v)	Provide a general method for updating the report.

Methods inherited from class jmri.implementation.AbstractNamedBean

addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, describeState, dispose, 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.NamedBean

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

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Constructor Detail

AbstractMemory

public AbstractMemory(java.lang.String systemName)

AbstractMemory

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

Method Detail

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

getValue

public java.lang.Object getValue()

Description copied from interface: Memory

Get the stored value. The type of this depends on what was stored...

Specified by:

getValue in interface Memory

Returns:

the stored value

setValue

public void setValue(java.lang.Object v)

Provide a general method for updating the report.

Specified by:

setValue in interface Memory

Parameters:

v - the value to store

compareSystemNameSuffix

@CheckReturnValue
public int compareSystemNameSuffix(@Nonnull
                                   java.lang.String suffix1,
                                   @Nonnull
                                   java.lang.String suffix2,
                                   @Nonnull
                                   NamedBean n)

Compare the suffix of this NamedBean's name with the suffix of the argument NamedBean's name for the NamedBean.compareTo(jmri.NamedBean) operation. This is intended to be a system-specific comparison that understands the various formats, etc. By default, does an alphanumeric-by-chunks comparison. Do a string comparison.

Specified by:

compareSystemNameSuffix in interface NamedBean

Overrides:

compareSystemNameSuffix in class AbstractNamedBean

Parameters:

suffix1 - The suffix for the 1st bean in the comparison

suffix2 - The suffix for the 2nd bean in the comparison

n - The other (second) NamedBean in the comparison

Returns:

-1,0,+1 for ordering if the names are well-formed; may not provide proper ordering if the names are not well-formed.