org.weborganic.xmldoclet
Class Options

java.lang.Object
  org.weborganic.xmldoclet.Options

public final class Options
extends Object

Container for the options for the XML Doclet.

Constructor Summary

Options()
Creates new options.

Method Summary

boolean	filter(ClassDoc doc) Filters the included set of classes by checking whether the given class matches all of the specified '-extends', '-implements' and '-annotated' options.
File	getDirectory() Returns the directory where to store the files.
Charset	getEncoding() Returns the charset to use to encode the output.
String	getFilename() Returns the name of the file for single output.
static int	getLength(String option) A JavaDoc option parsing handler.
com.sun.tools.doclets.Taglet	getTagletForName(String name) Returns the taglet instance for the specified tag name.
boolean	hasFilter() Indicates whether these options specify a filter.
static Options	toOptions(String[][] options, DocErrorReporter reporter) Retrieve the expected options from the given array of options.
String	toString()
boolean	useMultipleFiles() Indicates whether these options should use multiple files.
boolean	useSubFolders() Indicates whether to organise files as subfolders for packages.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Options

public Options()

Creates new options.

Method Detail

useMultipleFiles

public boolean useMultipleFiles()

Indicates whether these options should use multiple files.

useSubFolders

public boolean useSubFolders()

Indicates whether to organise files as subfolders for packages.

getEncoding

public Charset getEncoding()

Returns the charset to use to encode the output.

Returns:

the charset to use to encode the output.

getDirectory

public File getDirectory()

Returns the directory where to store the files.

Returns:

where to store the files.

getFilename

public String getFilename()

Returns the name of the file for single output.

Returns:

the name of the file for single output.

getTagletForName

public com.sun.tools.doclets.Taglet getTagletForName(String name)

Returns the taglet instance for the specified tag name.

Parameters:

name - The name of the tag.

Returns:

The corresponding Taglet or null.

hasFilter

public boolean hasFilter()

Indicates whether these options specify a filter.

Returns:

true if the class must implement or extends or have a specific annotation. false otherwise.

filter

public boolean filter(ClassDoc doc)

Filters the included set of classes by checking whether the given class matches all of the specified '-extends', '-implements' and '-annotated' options.

Parameters:

doc - the class documentation.

Returns:

true if the class should be included; false otherwise.

toString

public String toString()

Overrides:

toString in class Object

getLength

public static int getLength(String option)

A JavaDoc option parsing handler.

This one returns the number of arguments required for the given option.

Parameters:

option - The name of the option.

Returns:

The number of arguments for that option.

See Also:

Doclet.optionLength(String)

toOptions

public static Options toOptions(String[][] options,
                                DocErrorReporter reporter)

Retrieve the expected options from the given array of options.

Parameters:

root - The root object which contains the options to be retrieved.