weka.core

Class Javadoc

java.lang.Object

weka.core.Javadoc

All Implemented Interfaces:

OptionHandler, RevisionHandler

Direct Known Subclasses:

AllJavadoc, GlobalInfoJavadoc, OptionHandlerJavadoc, TechnicalInformationHandlerJavadoc

public abstract class Javadoc
extends java.lang.Object
implements OptionHandler, RevisionHandler

Abstract superclass for classes that generate Javadoc comments and replace the content between certain comment tags.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	m_Classname the classname
protected java.lang.String	m_Dir the directory above the class to update
protected java.lang.String[]	m_EndTag the end tag
protected boolean	m_Silent whether to suppress error messages (no printout in the console)
protected java.lang.String[]	m_StartTag the start tag
protected boolean	m_UseStars whether to include the stars in the Javadoc

Constructor Summary

Constructors

Constructor and Description
Javadoc()

Method Summary

Modifier and Type	Method and Description
protected boolean	canInstantiateClass() returns true if the class can be instantiated, i.e., has a default constructor.
java.lang.String	generate() generates either the plain Javadoc (if no filename specified) or the updated file (if a filename is specified).
java.lang.String	generateHelp() generates a string to print as help on the console
protected java.lang.String	generateJavadoc() generates and returns the Javadoc
protected abstract java.lang.String	generateJavadoc(int index) generates and returns the Javadoc for the specified start/end tag pair.
java.lang.String	getClassname() returns the current classname
java.lang.String	getDir() returns the current dir containing the class to update.
protected int	getIndentionLength(java.lang.String str) determines the number of indention strings that have to be inserted to generated the given indention string.
protected java.lang.String	getIndentionString(java.lang.String str) determines the base string of the given indention string, whether it's either only spaces (one space will be retured) or mixed mode (tabs and spaces, in that case the same string will be returned)
protected java.lang.Object	getInstance() Returns a new instance of the class
java.lang.String[]	getOptions() Gets the current settings of this object.
boolean	getSilent() whether output in the console is suppressed
boolean	getUseStars() whether the Javadoc is prefixed with "*"
protected java.lang.String	indent(java.lang.String content, int count, java.lang.String indentStr) indents the given string by a given number of indention strings
java.util.Enumeration<Option>	listOptions() Returns an enumeration describing the available options.
protected void	println(java.lang.Object o) prints the given object to System.err
protected static void	runJavadoc(Javadoc javadoc, java.lang.String[] options) runs the javadoc producer with the given commandline options
void	setClassname(java.lang.String value) sets the classname of the class to generate the Javadoc for
void	setDir(java.lang.String value) sets the dir containing the file that is to be updated.
void	setOptions(java.lang.String[] options) Parses a given list of options.
void	setSilent(boolean value) sets whether to suppress output in the console
void	setUseStars(boolean value) sets whether to prefix the Javadoc with "*"
protected java.lang.String	toHTML(java.lang.String s) converts the given String into HTML, i.e., replacing some char entities with HTML entities.
java.lang.String	updateJavadoc() generates the Javadoc and returns it applied to the source file if one was provided, otherwise an empty string.
protected java.lang.String	updateJavadoc(java.lang.String content) updates the Javadoc in the given source code.
protected java.lang.String	updateJavadoc(java.lang.String content, int index) generates and returns the Javadoc for the specified start/end tag pair

Methods inherited from class java.lang.Object

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

Methods inherited from interface weka.core.RevisionHandler

getRevision

Field Detail

m_StartTag

protected java.lang.String[] m_StartTag

the start tag

m_EndTag

protected java.lang.String[] m_EndTag

the end tag

m_Classname

protected java.lang.String m_Classname

the classname

m_UseStars

protected boolean m_UseStars

whether to include the stars in the Javadoc

m_Dir

protected java.lang.String m_Dir

the directory above the class to update

m_Silent

protected boolean m_Silent

whether to suppress error messages (no printout in the console)

Constructor Detail

Javadoc

public Javadoc()

Method Detail

listOptions

public java.util.Enumeration<Option> listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface OptionHandler

Returns:

an enumeration of all the available options.

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.Exception

Parses a given list of options.

Specified by:

setOptions in interface OptionHandler

Parameters:

options - the list of options as an array of strings

Throws:

java.lang.Exception - if an option is not supported

getOptions

public java.lang.String[] getOptions()

Gets the current settings of this object.

Specified by:

getOptions in interface OptionHandler

Returns:

an array of strings suitable for passing to setOptions

setClassname

public void setClassname(java.lang.String value)

sets the classname of the class to generate the Javadoc for

Parameters:

value - the new classname

getClassname

public java.lang.String getClassname()

returns the current classname

Returns:

the current classname

setUseStars

public void setUseStars(boolean value)

sets whether to prefix the Javadoc with "*"

Parameters:

value - true if stars are used

getUseStars

public boolean getUseStars()

whether the Javadoc is prefixed with "*"

Returns:

whether stars are used

setDir

public void setDir(java.lang.String value)

sets the dir containing the file that is to be updated. It is the dir above the package hierarchy of the class.

Parameters:

value - the directory containing the classes

getDir

public java.lang.String getDir()

returns the current dir containing the class to update. It is the dir above the package name of the class.

Returns:

the current directory

setSilent

public void setSilent(boolean value)

sets whether to suppress output in the console

Parameters:

value - true if output is to be suppressed

getSilent

public boolean getSilent()

whether output in the console is suppressed

Returns:

true if output is suppressed

println

protected void println(java.lang.Object o)

prints the given object to System.err

Parameters:

o - the object to print

canInstantiateClass

protected boolean canInstantiateClass()

returns true if the class can be instantiated, i.e., has a default constructor.

Returns:

true if the class can be instantiated

getInstance

protected java.lang.Object getInstance()

Returns a new instance of the class

Returns:

a new instance of the class

toHTML

protected java.lang.String toHTML(java.lang.String s)

converts the given String into HTML, i.e., replacing some char entities with HTML entities.

Parameters:

s - the string to convert

Returns:

the HTML conform string

indent

protected java.lang.String indent(java.lang.String content,
                                  int count,
                                  java.lang.String indentStr)

indents the given string by a given number of indention strings

Parameters:

content - the string to indent

count - the number of times to indent one line

indentStr - the indention string

Returns:

the indented content

generateJavadoc

protected abstract java.lang.String generateJavadoc(int index)
                                             throws java.lang.Exception

generates and returns the Javadoc for the specified start/end tag pair.

Parameters:

index - the index in the start/end tag array

Returns:

the generated Javadoc

Throws:

java.lang.Exception - in case the generation fails

generateJavadoc

protected java.lang.String generateJavadoc()
                                    throws java.lang.Exception

generates and returns the Javadoc

Returns:

the generated Javadoc

Throws:

java.lang.Exception - in case the generation fails

getIndentionString

protected java.lang.String getIndentionString(java.lang.String str)

determines the base string of the given indention string, whether it's either only spaces (one space will be retured) or mixed mode (tabs and spaces, in that case the same string will be returned)

Parameters:

str - the string to analyze

Returns:

the indention string

getIndentionLength

protected int getIndentionLength(java.lang.String str)

determines the number of indention strings that have to be inserted to generated the given indention string.

Parameters:

str - the string to analyze

Returns:

the number of base indention strings to insert

updateJavadoc

protected java.lang.String updateJavadoc(java.lang.String content,
                                         int index)
                                  throws java.lang.Exception

generates and returns the Javadoc for the specified start/end tag pair

Parameters:

content - the current source code

index - the index in the start/end tag array

Returns:

the generated Javadoc

Throws:

java.lang.Exception - in case the generation fails

updateJavadoc

protected java.lang.String updateJavadoc(java.lang.String content)
                                  throws java.lang.Exception

updates the Javadoc in the given source code.

Parameters:

content - the source code

Returns:

the updated source code

Throws:

java.lang.Exception - in case the generation fails

updateJavadoc

public java.lang.String updateJavadoc()
                               throws java.lang.Exception

generates the Javadoc and returns it applied to the source file if one was provided, otherwise an empty string.

Returns:

the generated Javadoc

Throws:

java.lang.Exception - in case the generation fails

generate

public java.lang.String generate()
                          throws java.lang.Exception

generates either the plain Javadoc (if no filename specified) or the updated file (if a filename is specified). The start and end tag for the global info have to be specified in the file in the latter case.

Returns:

either the plain Javadoc or the modified file

Throws:

java.lang.Exception - in case the generation fails

generateHelp

public java.lang.String generateHelp()

generates a string to print as help on the console

Returns:

the generated help

runJavadoc

protected static void runJavadoc(Javadoc javadoc,
                                 java.lang.String[] options)

runs the javadoc producer with the given commandline options

Parameters:

javadoc - the javadoc producer to execute

options - the commandline options