jmri.jmrit.logix
Class WarrantManager

java.lang.Object
  jmri.managers.AbstractManager
      jmri.jmrit.logix.WarrantManager

All Implemented Interfaces:

PropertyChangeListener, EventListener, Manager

public class WarrantManager
extends AbstractManager
implements PropertyChangeListener

Basic Implementation of a WarrantManager.

Note this is a concrete class.

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:

Pete Cressman Copyright (C) 2009

Field Summary

Fields inherited from class jmri.managers.AbstractManager

_tsys, _tuser

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

Constructor Summary

WarrantManager()

Method Summary

Warrant	createNewWarrant(String systemName, String userName) Method to create a new Warrant if it does not exist Returns null if a Warrant with the same systemName or userName already exists, or if there is trouble creating a new Warrant.
Warrant	getBySystemName(String name)
Warrant	getByUserName(String key)
String	getSystemPrefix() Provides access to the system prefix string.
Warrant	getWarrant(String name) Method to get an existing Warrant.
int	getXMLOrder()
static WarrantManager	instance()
Warrant	provideWarrant(String name)
char	typeLetter()

Methods inherited from class jmri.managers.AbstractManager

addPropertyChangeListener, deregister, dispose, firePropertyChange, getBeanBySystemName, getInstanceBySystemName, getInstanceByUserName, getSystemNameArray, getSystemNameList, makeSystemName, propertyChange, register, registerSelf, removePropertyChangeListener, systemLetter

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.beans.PropertyChangeListener

propertyChange

Constructor Detail

WarrantManager

public WarrantManager()

Method Detail

getXMLOrder

public int getXMLOrder()

Specified by:

getXMLOrder in interface Manager

Specified by:

getXMLOrder in class AbstractManager

getSystemPrefix

public String getSystemPrefix()

Description copied from interface: Manager

Provides access to the system prefix string. This was previously called the "System letter"

Specified by:

getSystemPrefix in interface Manager

typeLetter

public char typeLetter()

Specified by:

typeLetter in interface Manager

Returns:

The type letter for a specific implementation

createNewWarrant

public Warrant createNewWarrant(String systemName,
                                String userName)

Method to create a new Warrant if it does not exist Returns null if a Warrant with the same systemName or userName already exists, or if there is trouble creating a new Warrant.

getWarrant

public Warrant getWarrant(String name)

Method to get an existing Warrant. First looks up assuming that name is a User Name. If this fails looks up assuming that name is a System Name. If both fail, returns null.

getBySystemName

public Warrant getBySystemName(String name)

getByUserName

public Warrant getByUserName(String key)

provideWarrant

public Warrant provideWarrant(String name)

instance

public static WarrantManager instance()