org.ujac.print
Class ParameterDefinition

java.lang.Object
  org.ujac.print.ParameterDefinition

All Implemented Interfaces:

UjacTypes

public class ParameterDefinition
extends Object
implements UjacTypes

Name: ParameterDefinition
Description: A class, defining parameters.

Author:

lauerc

Field Summary

static int	TYPE_COLOR Constant for Color type.
static int	TYPE_FONT Constant for font type.
static int	TYPE_FORMAT Constant for Format type.

Fields inherited from interface org.ujac.util.UjacTypes

TYPE_BOOLEAN, TYPE_DATE, TYPE_DOUBLE, TYPE_FLOAT, TYPE_INT, TYPE_LONG, TYPE_NAME_BOOLEAN, TYPE_NAME_DATE, TYPE_NAME_DOUBLE, TYPE_NAME_FLOAT, TYPE_NAME_INT, TYPE_NAME_LONG, TYPE_NAME_OBJECT, TYPE_NAME_SHORT, TYPE_NAME_STRING, TYPE_NAME_TABLE, TYPE_NAME_TIME, TYPE_NAME_TIMESTAMP, TYPE_OBJECT, TYPE_SHORT, TYPE_STRING, TYPE_TABLE, TYPE_TIME, TYPE_TIMESTAMP

Constructor Summary

ParameterDefinition(String name, int type, boolean list, boolean optional, Object defaultValue)
Constructs a ParameterDefinition instance with specific attributes.

ParameterDefinition(String name, int type, boolean list, boolean optional, Object defaultValue, String description)
Constructs a ParameterDefinition instance with specific attributes.

Method Summary

Object	getDefaultValue() Gets the default value.
String	getDescription() Gets the parameter description.
String	getName() Gets the parameter name.
int	getType() Gets the parameter type.
boolean	isList() Gets the list flag
boolean	isOptional() Gets the optional flag
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_FONT

public static final int TYPE_FONT

Constant for font type.

See Also:

Constant Field Values

TYPE_FORMAT

public static final int TYPE_FORMAT

Constant for Format type.

See Also:

Constant Field Values

TYPE_COLOR

public static final int TYPE_COLOR

Constant for Color type.

See Also:

Constant Field Values

Constructor Detail

ParameterDefinition

public ParameterDefinition(String name,
                           int type,
                           boolean list,
                           boolean optional,
                           Object defaultValue)

Constructs a ParameterDefinition instance with specific attributes.

Parameters:

name - The parameter name.

type - The parameter type.

list - The list flag.

optional - The optional flag.

defaultValue - The parameter's default value.

ParameterDefinition

public ParameterDefinition(String name,
                           int type,
                           boolean list,
                           boolean optional,
                           Object defaultValue,
                           String description)

Constructs a ParameterDefinition instance with specific attributes.

Parameters:

name - The parameter name.

type - The parameter type.

list - The list flag.

optional - The optional flag.

defaultValue - The parameter's default value.

description - The parameter description.

Method Detail

getName

public String getName()

Gets the parameter name.

Returns:

The parameter name.

getType

public int getType()

Gets the parameter type.

Returns:

The parameter type.

isList

public boolean isList()

Gets the list flag

Returns:

The list flag.

isOptional

public boolean isOptional()

Gets the optional flag

Returns:

The optional flag.

getDefaultValue

public Object getDefaultValue()

Gets the default value.

Returns:

The default value.

getDescription

public String getDescription()

Gets the parameter description.

Returns:

The parameter description.

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()