quartz.lib.scheme.doc

Class DescriptiveDocumentCategory

java.lang.Object

quartz.lib.scheme.doc.DescriptiveDocumentCategory

public class DescriptiveDocumentCategory
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static void	addCategory(DescriptiveDocumentCategory category)
void	addDocumentList(gnu.mapping.Environment env, gnu.mapping.Symbol[] symbols, java.lang.Object descriptive)
static DescriptiveDocumentCategory	createCategory(java.lang.String symbol)
static DescriptiveDocumentCategory	createCategory(gnu.mapping.Symbol symbol)
java.lang.Object	defineDoc(gnu.mapping.Environment env, DescriptiveBean bean)
java.lang.Object	defineDoc(gnu.mapping.Environment env, java.lang.Object target, DescriptiveBean bean)
java.lang.Object	defineDoc(gnu.mapping.Environment env, java.lang.String targetVar, DescriptiveBean bean)
static java.lang.Object	defineDoc0(gnu.mapping.Environment env, DescriptiveDocumentCategory type, java.lang.String targetVar, java.lang.Object target, DescriptiveBean bean)
static java.lang.Object	defineDoc0(gnu.mapping.Environment env, DescriptiveDocumentCategory type, java.lang.String targetVar, java.lang.Object target, java.lang.String description, java.util.List<java.lang.String> names)
static java.util.Collection<DescriptiveDocumentCategory>	getAll()
gnu.lists.LList	getDocumentList(gnu.mapping.Environment env)
gnu.mapping.Symbol	getSymbol()
static void	outputAvailableReferences(java.lang.String outputFile)
static void	outputReference(gnu.mapping.Environment environment, java.lang.String categoryName, java.lang.String outputFile)
static void	removeCategory(DescriptiveDocumentCategory category)
static DescriptiveDocumentCategory	valueOf(java.lang.String symbolString)
static DescriptiveDocumentCategory	valueOf(gnu.mapping.Symbol symbol)

Methods inherited from class java.lang.Object

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

Method Detail

createCategory

public static DescriptiveDocumentCategory createCategory(gnu.mapping.Symbol symbol)

createCategory

public static DescriptiveDocumentCategory createCategory(java.lang.String symbol)

addCategory

public static void addCategory(DescriptiveDocumentCategory category)

removeCategory

public static void removeCategory(DescriptiveDocumentCategory category)

getAll

public static java.util.Collection<DescriptiveDocumentCategory> getAll()

valueOf

public static DescriptiveDocumentCategory valueOf(gnu.mapping.Symbol symbol)

valueOf

public static DescriptiveDocumentCategory valueOf(java.lang.String symbolString)

getSymbol

public gnu.mapping.Symbol getSymbol()

getDocumentList

public gnu.lists.LList getDocumentList(gnu.mapping.Environment env)

addDocumentList

public void addDocumentList(gnu.mapping.Environment env,
                            gnu.mapping.Symbol[] symbols,
                            java.lang.Object descriptive)

defineDoc

public java.lang.Object defineDoc(gnu.mapping.Environment env,
                                  DescriptiveBean bean)

defineDoc

public java.lang.Object defineDoc(gnu.mapping.Environment env,
                                  java.lang.String targetVar,
                                  DescriptiveBean bean)

defineDoc

public java.lang.Object defineDoc(gnu.mapping.Environment env,
                                  java.lang.Object target,
                                  DescriptiveBean bean)

defineDoc0

public static java.lang.Object defineDoc0(gnu.mapping.Environment env,
                                          DescriptiveDocumentCategory type,
                                          java.lang.String targetVar,
                                          java.lang.Object target,
                                          DescriptiveBean bean)

defineDoc0

public static java.lang.Object defineDoc0(gnu.mapping.Environment env,
                                          DescriptiveDocumentCategory type,
                                          java.lang.String targetVar,
                                          java.lang.Object target,
                                          java.lang.String description,
                                          java.util.List<java.lang.String> names)

outputAvailableReferences

public static void outputAvailableReferences(java.lang.String outputFile)
                                      throws java.io.FileNotFoundException,
                                             java.io.IOException

Throws:

java.io.FileNotFoundException

java.io.IOException

outputReference

public static void outputReference(gnu.mapping.Environment environment,
                                   java.lang.String categoryName,
                                   java.lang.String outputFile)
                            throws java.io.FileNotFoundException,
                                   java.io.IOException

Throws:

java.io.FileNotFoundException

java.io.IOException