Package jmri.util.startup

Class AbstractStartupActionFactory

java.lang.Object

jmri.util.startup.AbstractStartupActionFactory

All Implemented Interfaces:

JmriServiceProviderInterface, StartupActionFactory

Direct Known Subclasses:

AnalogClockStartupActionFactory, AppsStartupActionFactory, AutomatTableStartupActionFactory, BeanTableStartupActionFactory, BlockBossStartupActionFactory, ConfigureXmlStartupActionFactory, ConsistToolStartupActionFactory, CtcEditorStartup, CtcRunStartup, DispatcherStartupActionFactory, DualDecoderStartupActionFactory, JmriSRCPStartupActionFactory, JsonServerStartupActionFactory, JythonStartupActionFactory, LcdClockStartupActionFactory, LnTcpStartupActionFactory, MeterStartupActionFactory, NixieClockStartupActionFactory, OperationsStartupActionFactory, PanelStartupActionFactory, PowerStartupActionFactory, ResourceBundleStartupActionFactory, RosterFrameStartupActionFactory, RosterStartupActionFactory, SampleConfigStartUpActionFactory, SendPacketStartupActionFactory, ServerStartupActionFactory, SimpleClockStartupActionFactory, SimpleLightCtrlStartupActionFactory, SimpleProgStartupActionFactory, SimpleServerStartupActionFactory, SimpleTurnoutCtrlStartupActionFactory, SpeedometerStartupActionFactory, SpeedoStartupActionFactory, SymbolicProgStartupActionFactory, TabbedPreferencesActionFactory, TcpServerStartupActionFactory, ThrottleStartupActionFactory, TimeTableStartup, ToolsStartupActionFactory, TreeControlStartupActionFactory, UsbBrowserStartupActionFactory, VSDecoderCreationStartupActionFactory, WebServerStartupActionFactory, WiThrottleStartupActionFactory, Z21serverStartupActionFactory

public abstract class AbstractStartupActionFactory
extends java.lang.Object
implements StartupActionFactory

Abstract implementation of StartupActionFactory that covers some boilerplate code for most implementations.

Constructor Summary

Constructors

Constructor	Description
AbstractStartupActionFactory()

Method Summary

Modifier and Type	Method	Description
java.lang.String[]	getOverriddenClasses(java.lang.Class<?> clazz)	Get startup actions overridden by the given class.
java.lang.String	getTitle(java.lang.Class<?> clazz)	Get the title for the given class using the default locale.

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.util.startup.StartupActionFactory

getActionClasses, getTitle

Constructor Detail

AbstractStartupActionFactory

public AbstractStartupActionFactory()

Method Detail

getTitle

public java.lang.String getTitle(java.lang.Class<?> clazz)
                          throws java.lang.IllegalArgumentException

Get the title for the given class using the default locale.

This implementation calls StartupActionFactory.getTitle(java.lang.Class, java.util.Locale) with the default locale.

Specified by:

getTitle in interface StartupActionFactory

Parameters:

clazz - the class

Returns:

the title

Throws:

java.lang.IllegalArgumentException - if the class is not supported by this factory

getOverriddenClasses

public java.lang.String[] getOverriddenClasses(java.lang.Class<?> clazz)
                                        throws java.lang.IllegalArgumentException

Get startup actions overridden by the given class. This is designed to allow a new class to replace a deprecated class.

Note: the behavior is undefined if multiple classes override a single class.

This implementation returns an empty array.

Specified by:

getOverriddenClasses in interface StartupActionFactory

Parameters:

clazz - the class

Returns:

an empty array

Throws:

java.lang.IllegalArgumentException - if the class is not supported by this factory