jmri
Interface SignalMastManager

All Superinterfaces:

Manager

All Known Implementing Classes:

DefaultSignalMastManager

public interface SignalMastManager
extends Manager

Interface for obtaining signal masts.

This doesn't have a "new" method, as SignalMasts 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.

Author:

Bob Jacobsen Copyright (C) 2009

Field Summary

Fields inherited from interface jmri.Manager

AUDIO, BLOCKBOSS, BLOCKS, CONDITIONALS, IDTAGS, LAYOUTBLOCKS, LIGHTS, LOGIXS, MEMORIES, OBLOCKS, PANELFILES, REPORTERS, ROUTES, SECTIONS, SENSORGROUPS, SENSORS, SIGNALGROUPS, SIGNALHEADS, SIGNALMASTLOGICS, SIGNALMASTS, TIMEBASE, TRANSITS, TURNOUTS, WARRANTS

Method Summary

void	dispose() Free resources when no longer used.
SignalMast	getBySystemName(String s)
SignalMast	getByUserName(String s)
SignalMast	getSignalMast(String name) Locate via user name, then system name if needed.
List<String>	getSystemNameList() Get a list of all SignalHead system names.
SignalMast	provideSignalMast(String name) Locate via user name, then system name if needed.
SignalMast	provideSignalMast(String prefix, String signalSystem, String mastName, String[] heads)

Methods inherited from interface jmri.Manager

addPropertyChangeListener, deregister, getBeanBySystemName, getSystemNameArray, getSystemPrefix, getXMLOrder, makeSystemName, register, removePropertyChangeListener, systemLetter, typeLetter

Method Detail

dispose

void dispose()

Description copied from interface: Manager

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 Manager

getSignalMast

SignalMast getSignalMast(String name)

Locate via user name, then system name if needed. Does not create a new one if nothing found

Parameters:

name -

Returns:

null if no match found

provideSignalMast

SignalMast provideSignalMast(String name)

Locate via user name, then system name if needed. Create new one from system name if needed

Parameters:

name - User name, system name, or address which can be promoted to system name

Returns:

Never null

Throws:

IllegalArgumentException - if SignalMast doesn't already exist and the manager cannot create the SignalMast due to e.g. an illegal name or name that can't be parsed.

provideSignalMast

SignalMast provideSignalMast(String prefix,
                             String signalSystem,
                             String mastName,
                             String[] heads)

getByUserName

SignalMast getByUserName(String s)

getBySystemName

SignalMast getBySystemName(String s)

getSystemNameList

List<String> getSystemNameList()

Get a list of all SignalHead system names.

Specified by:

getSystemNameList in interface Manager