Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.common.align.extension.function
Class AbstractParameter

java.lang.Object
  extended by eu.esdihumboldt.hale.common.align.extension.function.AbstractParameter
Direct Known Subclasses:
FunctionParameter, PropertyParameter, TypeParameter

@Immutable
public abstract class AbstractParameter
extends Object

Abstract definition of a parameter based on an IConfigurationElement

Author:
Simon Templer

Field Summary
static int UNBOUNDED
          Value for maxOccurrence that represents an unbounded maximum occurrence
 
Constructor Summary
AbstractParameter(org.eclipse.core.runtime.IConfigurationElement conf)
          Create a parameter definition
 
Method Summary
 boolean equals(Object obj)
           
 String getDescription()
          Get the parameter description
 String getDisplayName()
          Get the display name for the parameter.
 int getMaxOccurrence()
           
 int getMinOccurrence()
           
 String getName()
           
 int hashCode()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

UNBOUNDED

public static final int UNBOUNDED
Value for maxOccurrence that represents an unbounded maximum occurrence

See Also:
Constant Field Values
Constructor Detail

AbstractParameter

public AbstractParameter(org.eclipse.core.runtime.IConfigurationElement conf)
Create a parameter definition

Parameters:
conf - the configuration element
Method Detail

getName

public final String getName()
Returns:
the parameter name

getMinOccurrence

public final int getMinOccurrence()
Returns:
the minimum occurrence of the parameter

getMaxOccurrence

public final int getMaxOccurrence()
Returns:
the maximum occurrence of the parameter

getDisplayName

public String getDisplayName()
Get the display name for the parameter. If present the parameter label will be used, otherwise the parameter name is returned. In case the parameter name is null an empty string is returned.

Returns:
the parameter display name

getDescription

public String getDescription()
Get the parameter description

Returns:
the description, may be null

hashCode

public int hashCode()
Overrides:
hashCode in class Object
See Also:
Object.hashCode()

equals

public boolean equals(Object obj)
Overrides:
equals in class Object
See Also:
Object.equals(java.lang.Object)

Humboldt Alignment Editor 2.5.0

Build 2012-12-03_12-30-59
Revision 9d2dd4b0318cda9f1393b1ddd390f7f792d70a2d