Package jmri.util.startup
Class AbstractActionModel
- java.lang.Object
-
- jmri.util.startup.AbstractActionModel
-
- All Implemented Interfaces:
StartupModel
- Direct Known Subclasses:
CreateButtonModel
,PerformActionModel
public abstract class AbstractActionModel extends java.lang.Object implements StartupModel
Provide services for invoking actions during configuration and startup.The action classes and corresponding human-readable names are provided by
StartupActionFactory
instances.- See Also:
AbstractActionModelFactory
-
-
Constructor Summary
Constructors Constructor Description AbstractActionModel()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
addException(java.lang.Exception exception)
Add an exception to the list of exceptions thrown when loading the model or performing the action.java.lang.String
getClassName()
java.util.List<java.lang.Exception>
getExceptions()
Get the exceptions thrown by the startup model.java.lang.String
getName()
Return the name of of the model or its controlled object.java.lang.String
getSystemPrefix()
boolean
isEnabled()
Get whenether this action is enabled or not.boolean
isSystemConnectionAction()
boolean
isValid()
Test is model is a valid model.void
performAction()
Perform the startup action.protected abstract void
performAction(javax.swing.Action action)
void
setClassName(java.lang.String n)
void
setEnabled(boolean value)
Set whenether this action is enabled or not.void
setName(java.lang.String n)
Set the name of the model.void
setSystemPrefix(java.lang.String prefix)
java.lang.String
toString()
-
-
-
Constructor Detail
-
AbstractActionModel
public AbstractActionModel()
-
-
Method Detail
-
getClassName
public java.lang.String getClassName()
-
getName
public java.lang.String getName()
Description copied from interface:StartupModel
Return the name of of the model or its controlled object.- Specified by:
getName
in interfaceStartupModel
- Returns:
- the name, an empty string, or null
-
setName
public void setName(java.lang.String n)
Description copied from interface:StartupModel
Set the name of the model.- Specified by:
setName
in interfaceStartupModel
- Parameters:
n
- the name, an empty string, or null
-
setClassName
public void setClassName(@Nonnull java.lang.String n)
-
getSystemPrefix
@Nonnull public java.lang.String getSystemPrefix()
-
setSystemPrefix
public void setSystemPrefix(@CheckForNull java.lang.String prefix)
-
isSystemConnectionAction
public boolean isSystemConnectionAction()
-
isValid
public boolean isValid()
Description copied from interface:StartupModel
Test is model is a valid model. Invalid models will not be shown or saved by the Startup Actions Preferences panel.- Specified by:
isValid
in interfaceStartupModel
- Returns:
- true if valid; false otherwise
-
setEnabled
public void setEnabled(boolean value)
Set whenether this action is enabled or not.- Specified by:
setEnabled
in interfaceStartupModel
- Parameters:
value
- true if enabled, false otherwise
-
isEnabled
public boolean isEnabled()
Get whenether this action is enabled or not.- Specified by:
isEnabled
in interfaceStartupModel
- Returns:
- true if enabled, false otherwise
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
performAction
public void performAction() throws JmriException
Description copied from interface:StartupModel
Perform the startup action. The caller is responsible to ensure that this startup model is enabled before calling this method.- Specified by:
performAction
in interfaceStartupModel
- Throws:
JmriException
- if there is an exception thrown initializing the startup item; the original exception should be available asThrowable.getCause()
-
getExceptions
public java.util.List<java.lang.Exception> getExceptions()
Description copied from interface:StartupModel
Get the exceptions thrown by the startup model.- Specified by:
getExceptions
in interfaceStartupModel
- Returns:
- the list of exceptions thrown during startup in order or an empty list if no exceptions were thrown
-
addException
public void addException(java.lang.Exception exception)
Description copied from interface:StartupModel
Add an exception to the list of exceptions thrown when loading the model or performing the action.- Specified by:
addException
in interfaceStartupModel
- Parameters:
exception
- the exception to retain with the model
-
performAction
protected abstract void performAction(javax.swing.Action action) throws JmriException
- Throws:
JmriException
-
-