quartz.lib.scheme.doc

Class DescriptiveBean

java.lang.Object

quartz.lib.scheme.doc.DescriptiveBean

All Implemented Interfaces:

java.lang.Cloneable, DescriptiveBeanSynopsisFormatter

Direct Known Subclasses:

ProceduralDescriptiveBean, PulsarNoteListDescriptiveBean

public abstract class DescriptiveBean
extends java.lang.Object
implements DescriptiveBeanSynopsisFormatter, java.lang.Cloneable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DescriptiveBean.Param

Constructor Summary

Constructors

Constructor and Description
DescriptiveBean()
DescriptiveBean(java.util.List<java.lang.String> names, java.lang.String parameterDescription, java.lang.String returnValueDescription, java.lang.String shortDescription, java.lang.String longDescription)

Method Summary

Modifier and Type	Method and Description
void	addParameter(int seriesNo, DescriptiveBean.Param param)
void	addParameter(int seriesNo, java.util.List<java.lang.String> names, java.lang.String type, java.lang.String defaultValue, boolean isVariable, java.lang.String description)
void	addParameter(int seriesNo, java.lang.String name, java.lang.String type, java.lang.String defaultValue, boolean isVariable, java.lang.String description)
DescriptiveBean	clone()
java.lang.String	format()
abstract java.lang.String	formatParameter(DescriptiveBean.Param param)
abstract java.lang.String	formatParameterDescription(int seriesNo)
java.lang.String	getLongDescription()
java.lang.String	getName()
java.util.List<java.lang.String>	getNames()
java.lang.String	getParameterDescription()
java.util.List<DescriptiveBean.Param>	getParameterList(int seriesNo)
int	getParameterListCount()
java.lang.String	getReturnValueDescription()
java.lang.String	getShortDescription()
DescriptiveBean	processArguments(java.lang.Object... args)
void	setLongDescription(java.lang.String longDescription)
DescriptiveBean	setNames(java.util.List<java.lang.String> names)
DescriptiveBean	setNames(java.lang.String... names)
void	setNames(gnu.mapping.Symbol... names)
void	setParameterDescription(java.lang.String parameterDescription)
void	setReturnValueDescription(java.lang.String returnValueDescription)
void	setShortDescription(java.lang.String shortDescription)

Methods inherited from class java.lang.Object

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

Methods inherited from interface quartz.lib.scheme.doc.DescriptiveBeanSynopsisFormatter

formatSynopsis

Constructor Detail

DescriptiveBean

public DescriptiveBean()

DescriptiveBean

public DescriptiveBean(java.util.List<java.lang.String> names,
                       java.lang.String parameterDescription,
                       java.lang.String returnValueDescription,
                       java.lang.String shortDescription,
                       java.lang.String longDescription)

Method Detail

clone

public DescriptiveBean clone()

Overrides:

clone in class java.lang.Object

getName

public java.lang.String getName()

getNames

public java.util.List<java.lang.String> getNames()

setNames

public DescriptiveBean setNames(java.lang.String... names)

setNames

public DescriptiveBean setNames(java.util.List<java.lang.String> names)

formatParameter

public abstract java.lang.String formatParameter(DescriptiveBean.Param param)

formatParameterDescription

public abstract java.lang.String formatParameterDescription(int seriesNo)

getParameterDescription

public java.lang.String getParameterDescription()

setParameterDescription

public void setParameterDescription(java.lang.String parameterDescription)

addParameter

public void addParameter(int seriesNo,
                         DescriptiveBean.Param param)

addParameter

public void addParameter(int seriesNo,
                         java.lang.String name,
                         java.lang.String type,
                         java.lang.String defaultValue,
                         boolean isVariable,
                         java.lang.String description)

addParameter

public void addParameter(int seriesNo,
                         java.util.List<java.lang.String> names,
                         java.lang.String type,
                         java.lang.String defaultValue,
                         boolean isVariable,
                         java.lang.String description)

getParameterList

public java.util.List<DescriptiveBean.Param> getParameterList(int seriesNo)

getParameterListCount

public int getParameterListCount()

getReturnValueDescription

public java.lang.String getReturnValueDescription()

setReturnValueDescription

public void setReturnValueDescription(java.lang.String returnValueDescription)

getShortDescription

public java.lang.String getShortDescription()

setShortDescription

public void setShortDescription(java.lang.String shortDescription)

getLongDescription

public java.lang.String getLongDescription()

setLongDescription

public void setLongDescription(java.lang.String longDescription)

processArguments

public DescriptiveBean processArguments(java.lang.Object... args)

format

public java.lang.String format()

setNames

public void setNames(gnu.mapping.Symbol... names)