org.ka2ddo.yaac.pluginapi

Class Provider.PortEntry

java.lang.Object

org.ka2ddo.yaac.pluginapi.Provider.PortEntry

All Implemented Interfaces:

java.util.Map.Entry<java.lang.String,java.lang.Class<? extends PortConnector>>

Enclosing class:

Provider

public static final class Provider.PortEntry
extends java.lang.Object
implements java.util.Map.Entry<java.lang.String,java.lang.Class<? extends PortConnector>>

This class describes the name and implementing Class of an interface port driver.

Author:

Andrew Pavlin, KA2DDO

Constructor Summary

Constructors

Constructor and Description
PortEntry(java.lang.String typeName, java.lang.Class<? extends PortConnector> pcClazz) Create a PortEntry instance.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getKey() Get the configuration type name for this PortEntry type.
java.lang.Class<? extends PortConnector>	getValue() Get the Class that implements the driver code for this PortEntry.
java.lang.Class<? extends PortConnector>	setValue(java.lang.Class<? extends PortConnector> value) DO NOT CALL; disabled for this class.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map.Entry

comparingByKey, comparingByKey, comparingByValue, comparingByValue, equals, hashCode

Constructor Detail

PortEntry

public PortEntry(java.lang.String typeName,
                 java.lang.Class<? extends PortConnector> pcClazz)

Create a PortEntry instance.

Parameters:

typeName - String internal configuration name for this port type (should be PortConnector subclass's TYPE_NAME String constant)

pcClazz - Class object implementing the driver code for this port type

Method Detail

getKey

public java.lang.String getKey()

Get the configuration type name for this PortEntry type.

Specified by:

getKey in interface java.util.Map.Entry<java.lang.String,java.lang.Class<? extends PortConnector>>

Returns:

String type name

getValue

public java.lang.Class<? extends PortConnector> getValue()

Get the Class that implements the driver code for this PortEntry.

Specified by:

getValue in interface java.util.Map.Entry<java.lang.String,java.lang.Class<? extends PortConnector>>

Returns:

Class with a no-args constructor

setValue

public java.lang.Class<? extends PortConnector> setValue(java.lang.Class<? extends PortConnector> value)

DO NOT CALL; disabled for this class.

Specified by:

setValue in interface java.util.Map.Entry<java.lang.String,java.lang.Class<? extends PortConnector>>

Parameters:

value - N/A

Returns:

nothing

Throws:

java.lang.UnsupportedOperationException - because this method is not allowed on this subclass