3.2.4: 2013-12-06

net.sf.basedb.util.extensions.manager
Class PluginInfoKey

java.lang.Object
  extended by net.sf.basedb.util.extensions.manager.PluginInfoKey
All Implemented Interfaces:
ObjectKey<PluginInfo>

public class PluginInfoKey
extends Object
implements ObjectKey<PluginInfo>

Key implementation used to identify plug-in definitions. Since a plug-in can be identified by it's class name, we use that as the key for equality.

Since:
3.0
Author:
Nicklas
See Also:
PluginInfo
Last modified
$Date$

Field Summary
private  String className
           
 
Constructor Summary
PluginInfoKey(PluginInfo info)
          Create a new key for an plug-in definition.
PluginInfoKey(String className)
          Create a new key for a plug-in with the given class name.
 
Method Summary
 boolean equals(Object obj)
           
 int hashCode()
           
 String toDescription()
          Get a string description of the key that is suitable for use in (error) messages to users.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

className

private final String className
Constructor Detail

PluginInfoKey

public PluginInfoKey(String className)
Create a new key for a plug-in with the given class name.

Parameters:
className - The class name (required)

PluginInfoKey

public PluginInfoKey(PluginInfo info)
Create a new key for an plug-in definition.

Parameters:
info - Information about the plug-in (required)
Method Detail

toDescription

public String toDescription()
Description copied from interface: ObjectKey
Get a string description of the key that is suitable for use in (error) messages to users.

Specified by:
toDescription in interface ObjectKey<PluginInfo>

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

toString

public String toString()
Overrides:
toString in class Object

3.2.4: 2013-12-06