quartz.lib.scheme.doc

Class ProceduralDescriptiveBean

java.lang.Object

quartz.lib.scheme.doc.DescriptiveBean

quartz.lib.scheme.doc.ProceduralDescriptiveBean

All Implemented Interfaces:

java.lang.Cloneable, DescriptiveBeanSynopsisFormatter

public class ProceduralDescriptiveBean
extends DescriptiveBean

Nested Class Summary

Nested classes/interfaces inherited from class quartz.lib.scheme.doc.DescriptiveBean

DescriptiveBean.Param

Constructor Summary

Constructors

Constructor and Description
ProceduralDescriptiveBean()
ProceduralDescriptiveBean(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
java.lang.String	formatParameter(DescriptiveBean.Param param)
java.lang.String	formatParameterDescription(int seriesNo)
java.lang.String	formatSynopsis(int seriesNo)

Methods inherited from class quartz.lib.scheme.doc.DescriptiveBean

addParameter, addParameter, addParameter, clone, format, getLongDescription, getName, getNames, getParameterDescription, getParameterList, getParameterListCount, getReturnValueDescription, getShortDescription, processArguments, setLongDescription, setNames, setNames, setNames, setParameterDescription, setReturnValueDescription, setShortDescription

Methods inherited from class java.lang.Object

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

Constructor Detail

ProceduralDescriptiveBean

public ProceduralDescriptiveBean()

ProceduralDescriptiveBean

public ProceduralDescriptiveBean(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

formatParameter

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

Specified by:

formatParameter in class DescriptiveBean

formatParameterDescription

public java.lang.String formatParameterDescription(int seriesNo)

Specified by:

formatParameterDescription in class DescriptiveBean

formatSynopsis

public java.lang.String formatSynopsis(int seriesNo)