net.sf.farrago.plugin
Class FarragoPluginInfoList

java.lang.Object
  net.sf.farrago.plugin.FarragoPluginInfoList

public class FarragoPluginInfoList
extends Object

FarragoPluginInfoList is a helper class for building up the arrays of DriverPropertyInfo returned by various getXXXPropertyInfo calls.

Version:

$Id: //open/dev/farrago/src/net/sf/farrago/plugin/FarragoPluginInfoList.java#11 $

Author:

John V. Sichi

Field Summary

private Properties	defaultProps
private List<DriverPropertyInfo>	propertyInfoList

Constructor Summary

FarragoPluginInfoList(Properties defaultProps)
Creates an empty info set.

Method Summary

DriverPropertyInfo	addOptionalPropertyInfo(String propertyName, String defaultValue, String description) Adds optional property information.
DriverPropertyInfo	addRequiredPropertyInfo(String propertyName, String defaultValue, String description) Adds required property information.
DriverPropertyInfo[]	toArray() Converts the list built up with addXXXPropertyInfo to an array suitable for return from a getXXXPropertyInfo call.

Methods inherited from class java.lang.Object

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

Field Detail

defaultProps

private Properties defaultProps

propertyInfoList

private List<DriverPropertyInfo> propertyInfoList

Constructor Detail

FarragoPluginInfoList

public FarragoPluginInfoList(Properties defaultProps)

Creates an empty info set.

Parameters:

defaultProps - Properties in which to look up default values

Method Detail

addOptionalPropertyInfo

public DriverPropertyInfo addOptionalPropertyInfo(String propertyName,
                                                  String defaultValue,
                                                  String description)

Adds optional property information.

Parameters:

propertyName - name of the property

defaultValue - String representation of default value to use if property name not present in defaultProps

description - localized description

Returns:

created info (the choices attribute can be set after return)

addRequiredPropertyInfo

public DriverPropertyInfo addRequiredPropertyInfo(String propertyName,
                                                  String defaultValue,
                                                  String description)

Adds required property information.

Parameters:

propertyName - name of the property

defaultValue - String representation of default value to use if property name not present in defaultProps

description - localized description

Returns:

created info (the choices attribute can be set after return)

toArray

public DriverPropertyInfo[] toArray()

Converts the list built up with addXXXPropertyInfo to an array suitable for return from a getXXXPropertyInfo call.

Returns:

the converted array