org.figure8.join.core
Class ParameterDefinition

java.lang.Object
  extended by org.figure8.join.core.ParameterDefinition
All Implemented Interfaces:
java.io.Serializable

public class ParameterDefinition
extends java.lang.Object
implements java.io.Serializable

This is a simple bean allowing to describe the definition of a Configurable object or service parameter. This definition is made of this parameter name, description, a default value and whether parameter is mandatory or not.

Version:
$Revision: 1.2 $
Author:
Laurent Broudoux
See Also:
Serialized Form

Constructor Summary
ParameterDefinition(java.lang.String name, java.lang.String description, java.lang.String defaultValue, boolean mandatory)
          Creates a new instance of ParemeterDefinition with attributes.
 
Method Summary
 java.lang.String getDefaultValue()
           
 java.lang.String getDescription()
           
 java.lang.String getName()
           
 boolean isMandatory()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ParameterDefinition

public ParameterDefinition(java.lang.String name,
                           java.lang.String description,
                           java.lang.String defaultValue,
                           boolean mandatory)
Creates a new instance of ParemeterDefinition with attributes.

Parameters:
name - The name of parameter
description - The description of parameter
defaultValue - A default value (or at least and example) for parameter
mandatory - Whetther this paramater is mandatory
Method Detail

getName

public java.lang.String getName()
Returns:
The name of this parameter.

getDescription

public java.lang.String getDescription()
Returns:
The description of this parameter.

getDefaultValue

public java.lang.String getDefaultValue()
Returns:
The default value for this parameter.

isMandatory

public boolean isMandatory()
Returns:
Whether this parameter is mandatory or not.


Copyright © 2005-2008 Join. All Rights Reserved.