grammarscope.generator.data

Class Doclet

java.lang.Object

grammarscope.generator.data.Doclet

public class Doclet
extends java.lang.Object

Doclet (requires tweaked GrammaticalRelation class in the path)

Author:

Bernard Bou

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static interface	Doclet.IProcessor Processor interface
(package private) static class	Doclet.NoOpProcessor
(package private) static class	Doclet.OutputMode Output mode

Field Summary

Fields

Modifier and Type	Field and Description
private static Doclet.OutputMode	theMode
(package private) static java.util.Map<java.lang.String,edu.stanford.nlp.trees.GrammaticalRelation>	theNameToRelationMap
private static java.lang.String	theOutputClass Output class
private static java.lang.String	theOutputFile Output file
(package private) static java.util.Map<edu.stanford.nlp.trees.GrammaticalRelation,java.lang.String>	theRelationToNameMap

Constructor Summary

Constructors

Constructor and Description
Doclet() Constructor

Method Summary

Modifier and Type	Method and Description
static void	main(java.lang.String[] theseArgs0) Main entry point
private static void	makeMaps(java.lang.String thisClass) Make maps
static int	optionLength(java.lang.String option)
private static java.lang.String	parseComment(java.lang.String thisComment0, java.util.List<java.lang.String[]> thisCodedExampleList) Parse comment
private static boolean	process(com.sun.javadoc.ClassDoc thisClassDoc, java.lang.String thisSource, java.lang.String thisDestination, java.io.PrintWriter thisPrintWriter, Doclet.IProcessor thisProcessor) Process specified source file
(package private) static void	processEntry(java.lang.String thisName, java.lang.String thisDescription, java.lang.String[][] theseCodedExamples, java.io.PrintWriter thisPrintWriter, Doclet.IProcessor thisProcessor) Print entry
private static void	readOptions(java.lang.String[][] theseOptions)
static boolean	start(com.sun.javadoc.RootDoc thisRootDoc) Start
(package private) static java.lang.String	toStringArray(java.lang.String[][] theseStrings)
(package private) static java.lang.String	toStringArray(java.lang.String[] theseStrings, boolean quote)
(package private) static java.lang.String	toStringArray1(java.lang.String[][] theseStrings)
static boolean	validOptions(java.lang.String[][] theseOptions, com.sun.javadoc.DocErrorReporter thisReporter)

Methods inherited from class java.lang.Object

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

Field Detail

theNameToRelationMap

static java.util.Map<java.lang.String,edu.stanford.nlp.trees.GrammaticalRelation> theNameToRelationMap

theRelationToNameMap

static java.util.Map<edu.stanford.nlp.trees.GrammaticalRelation,java.lang.String> theRelationToNameMap

theOutputFile

private static java.lang.String theOutputFile

Output file

theOutputClass

private static java.lang.String theOutputClass

Output class

theMode

private static Doclet.OutputMode theMode

Constructor Detail

Doclet

public Doclet()
       throws java.lang.SecurityException,
              java.lang.IllegalArgumentException,
              java.lang.InstantiationException,
              java.lang.IllegalAccessException,
              java.lang.NoSuchMethodException,
              java.lang.reflect.InvocationTargetException,
              java.lang.NoSuchFieldException

Constructor

Throws:

java.lang.SecurityException - exception

java.lang.IllegalArgumentException - exception

java.lang.InstantiationException - exception

java.lang.IllegalAccessException - exception

java.lang.NoSuchMethodException - exception

java.lang.reflect.InvocationTargetException - exception

java.lang.NoSuchFieldException - exception

Method Detail

makeMaps

private static void makeMaps(java.lang.String thisClass)

Make maps

Parameters:

thisClass - class containing instance as static member

start

public static boolean start(com.sun.javadoc.RootDoc thisRootDoc)
                     throws java.io.FileNotFoundException,
                            java.lang.SecurityException,
                            java.lang.IllegalArgumentException,
                            java.lang.InstantiationException,
                            java.lang.IllegalAccessException,
                            java.lang.NoSuchMethodException,
                            java.lang.reflect.InvocationTargetException,
                            java.lang.NoSuchFieldException

Start

Parameters:

thisRootDoc - root doc

Returns:

true if processed without error

Throws:

java.io.FileNotFoundException - exception

java.lang.SecurityException - exception

java.lang.IllegalArgumentException - exception

java.lang.InstantiationException - exception

java.lang.IllegalAccessException - exception

java.lang.NoSuchMethodException - exception

java.lang.reflect.InvocationTargetException - exception

java.lang.NoSuchFieldException - exception

process

private static boolean process(com.sun.javadoc.ClassDoc thisClassDoc,
                               java.lang.String thisSource,
                               java.lang.String thisDestination,
                               java.io.PrintWriter thisPrintWriter,
                               Doclet.IProcessor thisProcessor)
                        throws java.lang.IllegalArgumentException,
                               java.lang.SecurityException,
                               java.lang.IllegalAccessException,
                               java.lang.reflect.InvocationTargetException,
                               java.lang.NoSuchMethodException

Process specified source file

Parameters:

thisClassDoc - class doc to process

thisSource - source

thisDestination - destination

thisPrintWriter - print writer for output

thisProcessor - processor

Returns:

true if processed without error

Throws:

java.lang.IllegalArgumentException - exception

java.lang.SecurityException - exception

java.lang.IllegalAccessException - exception

java.lang.reflect.InvocationTargetException - exception

java.lang.NoSuchMethodException - exception

parseComment

private static java.lang.String parseComment(java.lang.String thisComment0,
                                             java.util.List<java.lang.String[]> thisCodedExampleList)

Parse comment

Parameters:

thisComment0 - comment

thisCodedExampleList - coded exaple list

Returns:

description

processEntry

static void processEntry(java.lang.String thisName,
                         java.lang.String thisDescription,
                         java.lang.String[][] theseCodedExamples,
                         java.io.PrintWriter thisPrintWriter,
                         Doclet.IProcessor thisProcessor)
                  throws java.lang.IllegalArgumentException,
                         java.lang.SecurityException,
                         java.lang.IllegalAccessException,
                         java.lang.reflect.InvocationTargetException,
                         java.lang.NoSuchMethodException

Print entry

Parameters:

thisName - name

thisDescription - description

theseCodedExamples - array of (example,code) pairs

thisPrintWriter - printwriter

thisProcessor - processor

Throws:

java.lang.IllegalArgumentException - exception

java.lang.SecurityException - exception

java.lang.IllegalAccessException - exception

java.lang.reflect.InvocationTargetException - exception

java.lang.NoSuchMethodException - exception

toStringArray

static java.lang.String toStringArray(java.lang.String[] theseStrings,
                                      boolean quote)

toStringArray

static java.lang.String toStringArray(java.lang.String[][] theseStrings)

toStringArray1

static java.lang.String toStringArray1(java.lang.String[][] theseStrings)

readOptions

private static void readOptions(java.lang.String[][] theseOptions)

optionLength

public static int optionLength(java.lang.String option)

validOptions

public static boolean validOptions(java.lang.String[][] theseOptions,
                                   com.sun.javadoc.DocErrorReporter thisReporter)

main

public static void main(java.lang.String[] theseArgs0)

Main entry point

Parameters:

theseArgs0 - save arguments as javadoc