Package jmri.jmrix.swing

Interface SystemConnectionAction<M extends SystemConnectionMemo>

Type Parameters:

M - the supported subclass of SystemConnectionMemo

All Known Implementing Classes:

AbstractSystemConnectionAction, AbstractXPressNetAction, AcelaMonAction, ClockMonPaneAction, ClockMonPanel.Default, CMRISystemConnectionAction, ConfigBaseStationAction, DCCppMonAction, DCCppSystemConnectionAction, Dcs210PlusUsbModeSelectPane.Default, Dcs240PlusUsbModeSelectPane.Default, Dcs240UsbModeSelectPane.Default, Dcs52UsbModeSelectPane.Default, DuplexGroupInfoPanel.Default, EcosMonPane.Default, EcosNamedPaneAction, GrapevineSystemConnectionAction, LI101Action, LIUSBConfigAction, LncvProgAction, LnNamedPaneAction, LocoDataPane, LocoDataPane.Default, LocoMonPaneAction, LocoStatsPanelAction, LZ100Action, LZV100Action, Mx1MonPanelAction, Mx1NamedPaneAction, Mx1PacketGenPanel.Default, NceConsistEditPanel.Default, NceMacroEditPanel.Default, NceMacroGenPanel.Default, NceMonPanel.Default, NceNamedPaneAction, NcePacketGenPanel.Default, NcePacketMonitorPanel.Default, NceShowCabPanel.Default, NodeTableAction, PacketGenAction, PacketGenAction, PacketGenAction, PacketGenAction, PacketGenAction, PacketGenPanel, PowerlineSystemConnectionAction, Pr3SelectPaneAction, Pr4SelectPane.Default, QsiMonAction, QsiSystemConnectionAction, SerialMonAction, SerialMonAction, SerialPacketGenAction, SerialPacketGenAction, SlotMonPaneAction, SRCPSystemConnectionAction, StackMonAction, StatusPanel, StatusPanel.Default, StatusPanelAction, SystemConnectionNamedPaneAction, SystemInfoAction, TamsMonPaneAction, TamsNamedPaneAction, TamsPanel, VirtualLCDAction, XBeeSystemConnectionAction

public interface SystemConnectionAction<M extends SystemConnectionMemo>

Interface for a Action that is bound to a SystemConnectionMemo.

Method Summary

Modifier and Type	Method	Description
M	getSystemConnectionMemo()	Get the SystemConnectionMemo this action is bound to.
java.util.Set<java.lang.Class<? extends SystemConnectionMemo>>	getSystemConnectionMemoClasses()	Get a list of SystemConnectionMemo subclasses that the implementing class accepts.
void	setSystemConnectionMemo(M memo)	Set the SystemConnectionMemo this action is bound to.

Method Detail

getSystemConnectionMemo

@CheckForNull
M getSystemConnectionMemo()

Get the SystemConnectionMemo this action is bound to.

Returns:

the SystemConnectionMemo or null if not bound.

setSystemConnectionMemo

void setSystemConnectionMemo(@Nonnull
                             M memo)

Set the SystemConnectionMemo this action is bound to.

Implementing classes may throw an IllegalArgumentException if the implementing class requires a specific subclass of SystemConnectionMemo.

Parameters:

memo - the SystemConnectionMemo

Throws:

java.lang.IllegalArgumentException - if the SystemConnectionMemo is invalid

getSystemConnectionMemoClasses

@Nonnull
java.util.Set<java.lang.Class<? extends SystemConnectionMemo>> getSystemConnectionMemoClasses()

Get a list of SystemConnectionMemo subclasses that the implementing class accepts.

If the implementing class is a subclass of a class that does accept SystemConnectionMemos, but the implementing class does not accept any, return an empty array instead of null.

Returns:

Set of SystemConnectionMemo subclasses or empty array.