Provider.PortEntry

java.lang.Object

org.ka2ddo.yaac.pluginapi.Provider.PortEntry

All Implemented Interfaces:: Map.Entry<String,Class<? extends PortConnector>>

Enclosing class:: Provider

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

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

Author:: Andrew Pavlin, KA2DDO

Constructor Summary

Constructors

Constructor

Description

PortEntry(String typeName, Class<? extends PortConnector> pcClazz)

Create a PortEntry instance.
Method Summary

Modifier and Type

Method

Description

String

getKey()

Get the configuration type name for this PortEntry type.

Class<? extends PortConnector>

getValue()

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

Class<? extends PortConnector>

setValue(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
equals, hashCode

Constructor Details
- PortEntry
  
  public PortEntry(String typeName, 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 Details
- getKey
  
  public String getKey()
  
  Get the configuration type name for this PortEntry type.
  
  Specified by:
  
  getKey in interface Map.Entry<String,Class<? extends PortConnector>>
  
  Returns:
  
  String type name
- getValue
  
  public Class<? extends PortConnector> getValue()
  
  Get the Class that implements the driver code for this PortEntry.
  
  Specified by:
  
  getValue in interface Map.Entry<String,Class<? extends PortConnector>>
  
  Returns:
  
  Class with a no-args constructor
- setValue
  
  public Class<? extends PortConnector> setValue(Class<? extends PortConnector> value)
  
  DO NOT CALL; disabled for this class.
  
  Specified by:
  
  setValue in interface Map.Entry<String,Class<? extends PortConnector>>
  
  Parameters:
  
  value - N/A
  
  Returns:
  
  nothing
  
  Throws:
  
  UnsupportedOperationException - because this method is not allowed on this subclass