Package jmri

Interface SignalHeadManager

All Superinterfaces:

Disposable, Manager<SignalHead>, PropertyChangeProvider, SilenceablePropertyChangeProvider, VetoableChangeProvider

All Known Implementing Classes:

AbstractSignalHeadManager

public interface SignalHeadManager
extends Manager<SignalHead>, Disposable

Interface for obtaining signal heads.

This doesn't have a "new" method, as SignalHeads are separately implemented, instead of being system-specific.

This file is part of JMRI.

JMRI is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. See the "COPYING" file for a copy of this license.

JMRI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.Manager

Manager.ManagerDataEvent<E extends NamedBean>, Manager.ManagerDataListener<E extends NamedBean>, Manager.NameValidity

Field Summary

Fields inherited from interface jmri.Manager

ANALOGIOS, AUDIO, BLOCKBOSS, BLOCKS, CONDITIONALS, CTCDATA, ENTRYEXIT, IDTAGS, LAYOUTBLOCKS, LIGHTS, LOGIXNG_ANALOG_ACTIONS, LOGIXNG_ANALOG_EXPRESSIONS, LOGIXNG_CONDITIONALNGS, LOGIXNG_DIGITAL_ACTIONS, LOGIXNG_DIGITAL_BOOLEAN_ACTIONS, LOGIXNG_DIGITAL_EXPRESSIONS, LOGIXNG_GLOBAL_VARIABLES, LOGIXNG_MODULES, LOGIXNG_STRING_ACTIONS, LOGIXNG_STRING_EXPRESSIONS, LOGIXNG_TABLES, LOGIXNGS, LOGIXS, MEMORIES, METERFRAMES, METERS, OBLOCKS, PANELFILES, REPORTERS, ROUTES, SECTIONS, SENSORGROUPS, SENSORS, SIGNALGROUPS, SIGNALHEADS, SIGNALMASTLOGICS, SIGNALMASTS, STRINGIOS, TIMEBASE, TRANSITS, TURNOUTS, WARRANTS

Method Summary

Modifier and Type	Method	Description
void	dispose()	Free resources when no longer used.
SignalHead	getBySystemName(java.lang.String name)	Get an existing SignalHead or return null if it doesn't exist.
SignalHead	getByUserName(java.lang.String name)	Get an existing SignalHead or return null if it doesn't exist.
SignalHead	getSignalHead(java.lang.String name)	Get an existing SignalHead or return null if it doesn't exist.

Methods inherited from interface jmri.Manager

addDataListener, deleteBean, deregister, getBeanTypeHandled, getBeanTypeHandled, getEntryToolTip, getKnownBeanProperties, getMemo, getNamedBean, getNamedBeanClass, getNamedBeanSet, getObjectCount, getSubSystemNamePrefix, getSystemNamePrefix, getSystemPrefix, getXMLOrder, isValidSystemNameFormat, makeSystemName, makeSystemName, makeSystemName, register, removeDataListener, setDataListenerMute, typeLetter, validateBadCharsInSystemNameFormat, validateIntegerSystemNameFormat, validateNmraAccessorySystemNameFormat, validateSystemNameFormat, validateSystemNameFormat, validateSystemNameFormatOnlyNumeric, validateSystemNamePrefix, validateTrimmedMin1NumberSystemNameFormat, validateTrimmedSystemNameFormat, validateUppercaseTrimmedSystemNameFormat, validSystemNameFormat

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface jmri.beans.SilenceablePropertyChangeProvider

setPropertyChangesSilenced

Methods inherited from interface jmri.beans.VetoableChangeProvider

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener

Method Detail

dispose

void dispose()

Free resources when no longer used. Specifically, remove all references to and from this object, so it can be garbage-collected.

Specified by:

dispose in interface Disposable

Specified by:

dispose in interface Manager<SignalHead>

getSignalHead

@CheckReturnValue
@CheckForNull
SignalHead getSignalHead(@Nonnull
                         java.lang.String name)

Get an existing SignalHead or return null if it doesn't exist. Locates via user name, then system name if needed.

Parameters:

name - User name or system name to match

Returns:

null if no match found

getByUserName

@CheckReturnValue
@CheckForNull
SignalHead getByUserName(@Nonnull
                         java.lang.String name)

Get an existing SignalHead or return null if it doesn't exist. Locates via user name.

Specified by:

getByUserName in interface Manager<SignalHead>

Parameters:

name - User name o to match

Returns:

null if no match found

getBySystemName

@CheckReturnValue
@CheckForNull
SignalHead getBySystemName(@Nonnull
                           java.lang.String name)

Get an existing SignalHead or return null if it doesn't exist. Locates via system name.

Specified by:

getBySystemName in interface Manager<SignalHead>

Parameters:

name - System name to match

Returns:

null if no match found