buldocs Ltd.
xnsdoc 1.2.1 Java API
A B C D E F G I M N P R S T V W X

A

addBottom(Task.Html) - Method in class com.xnsdoc.Task
Set the text to be placed at the bottom of each output file.
addDoctitle(Task.Html) - Method in class com.xnsdoc.Task
Add a document title to use for the overview page.
addFileset(FileSet) - Method in class com.xnsdoc.Task
Adds a set of files to be deleted.
addFooter(Task.Html) - Method in class com.xnsdoc.Task
Set the footer text to be placed at the bottom of each output file.
addHeader(Task.Html) - Method in class com.xnsdoc.Task
Set the header text to be placed at the top of each output file.
addSchema(String) - Method in class com.xnsdoc.Processor.MediatorSchema
Adds a schema defined by a file name to a mediator schema.
addSchema(String) - Method in class com.xnsdoc.Processor
Adds a schema defined by a file name to a mediator schema.
addText(String) - Method in class com.xnsdoc.Task.Html
Add text to the element.

B

BaseProcessor - class com.xnsdoc.BaseProcessor.
Abstract base class for the xnsdoc processor.
BaseProcessor() - Constructor for class com.xnsdoc.BaseProcessor
Default constructor.

C

ConsoleListener - class com.xnsdoc.ConsoleListener.
Implementation of the ProcessorListener interface that simple logs everything to the console.
ConsoleListener() - Constructor for class com.xnsdoc.ConsoleListener
Constructor.
ConsoleListener(int) - Constructor for class com.xnsdoc.ConsoleListener
Constructor.
com.xnsdoc - package com.xnsdoc
This package contains all public Java classes related to xnsdoc.

D

DEBUG - Static variable in interface com.xnsdoc.ProcessorListener
listening level.
debug(String) - Method in class com.xnsdoc.ConsoleListener
 
debug(String) - Method in interface com.xnsdoc.ProcessorListener
Log a message with debug log level.

E

ERROR - Static variable in interface com.xnsdoc.ProcessorListener
listening level.
end() - Method in class com.xnsdoc.ConsoleListener
 
end() - Method in interface com.xnsdoc.ProcessorListener
Signals end of processing.
error(String) - Method in class com.xnsdoc.ConsoleListener
 
error(String) - Method in interface com.xnsdoc.ProcessorListener
Log a message with error log level.
execute() - Method in class com.xnsdoc.Processor
Execution of the processor.
execute() - Method in class com.xnsdoc.Task
Execute the task.

F

FATAL - Static variable in interface com.xnsdoc.ProcessorListener
listening level.
fatal(String) - Method in class com.xnsdoc.ConsoleListener
 
fatal(String) - Method in interface com.xnsdoc.ProcessorListener
Log a message with fatal log level.

G

getDocument() - Method in class com.xnsdoc.Processor.MediatorSchema
Returns the mediator schema as a DOM document.
getLevel() - Method in class com.xnsdoc.ConsoleListener
 
getLevel() - Method in interface com.xnsdoc.ProcessorListener
Returns the current verbosity level.
getListener() - Method in class com.xnsdoc.BaseProcessor
Getter method for listener property.
getLocalizedMessage() - Method in class com.xnsdoc.ProcessorException
 
getMessage() - Method in class com.xnsdoc.ProcessorException
 
getString(String) - Static method in class com.xnsdoc.Messages
Returns the i18n message for a given message key.
getString(String, String) - Static method in class com.xnsdoc.Messages
Returns the i18n message for a given message key.
getString(String, long) - Static method in class com.xnsdoc.Messages
Returns the i18n message for a given message key.
getString(String, String, String) - Static method in class com.xnsdoc.Messages
Returns the i18n message for a given message key.
getText() - Method in class com.xnsdoc.Task.Html
Get the current text for the element.

I

INFO - Static variable in interface com.xnsdoc.ProcessorListener
listening level.
info(String) - Method in class com.xnsdoc.ConsoleListener
 
info(String) - Method in interface com.xnsdoc.ProcessorListener
Log a message with info log level.
isDebug() - Method in class com.xnsdoc.BaseProcessor
Getter method for debug property.
isVerbose() - Method in class com.xnsdoc.BaseProcessor
Getter method for debug property.

M

Main - class com.xnsdoc.Main.
Command line interface of xnsdoc.
Messages - class com.xnsdoc.Messages.
Accessor class for i18n messages of xnsdoc.
main(String[]) - Static method in class com.xnsdoc.Main
Main method of command line interface of xnsdoc.

N

NAMESPACE_NAMESPACE - Static variable in class com.xnsdoc.BaseProcessor
Namespace-URI of namespace of W3C-XML-Namespace.

P

Processor - class com.xnsdoc.Processor.
The xnsdoc processor.
Processor() - Constructor for class com.xnsdoc.Processor
Default constructor.
Processor.MediatorSchema - class com.xnsdoc.Processor.MediatorSchema.
Collector for multiple schema file.
Processor.MediatorSchema() - Constructor for class com.xnsdoc.Processor.MediatorSchema
Constructor.
ProcessorException - exception com.xnsdoc.ProcessorException.
Exception class for excpetions occuring in the processor.
ProcessorException(String) - Constructor for class com.xnsdoc.ProcessorException
Constructs a ProcessorException with the specified detail message.
ProcessorException(Throwable) - Constructor for class com.xnsdoc.ProcessorException
Constructs a ProcessorException with the specified causing eception.
ProcessorException(String, Throwable) - Constructor for class com.xnsdoc.ProcessorException
Constructs a ProcessorException with the specified detail message and causing eception.
ProcessorListener - interface com.xnsdoc.ProcessorListener.
Listener interface for logging.

R

RESOURCE_PROTOCOL - Static variable in class com.xnsdoc.BaseProcessor
protocol prefix for resource files.
run() - Method in class com.xnsdoc.Processor
Executes the processor and returns a string with all messages and exceptions that are normally sent to System.out.

S

SCHEMA_NS - Static variable in class com.xnsdoc.BaseProcessor
namespace of XML schema.
setBottom(String) - Method in class com.xnsdoc.Processor
Setter method for bottom property.
setBottom(String) - Method in class com.xnsdoc.Task
Set the text to be placed at the bottom of each output file.
setCreateFolder(boolean) - Method in class com.xnsdoc.Processor
Setter method for createFolder property.
setCss(String) - Method in class com.xnsdoc.Processor
Setter method for CSS property.
setCss(String) - Method in class com.xnsdoc.Task
Setter method for css property.
setDatatypes(boolean) - Method in class com.xnsdoc.Processor
Setter method for datatypes property.
setDebug(boolean) - Method in class com.xnsdoc.BaseProcessor
Setter method for debug property.
setDebug(boolean) - Method in class com.xnsdoc.Task
Setter method for debug property.
setDir(String) - Method in class com.xnsdoc.Task
Setter method for dir property.
setDoctitle(String) - Method in class com.xnsdoc.Processor
Setter method for title property.
setDoctitle(String) - Method in class com.xnsdoc.Task
Set the title of the generated overview page.
setFailonerror(boolean) - Method in class com.xnsdoc.Task
Setter method for failonerror attribute.
setFile(String) - Method in class com.xnsdoc.Task
Setter method for file property.
setFooter(String) - Method in class com.xnsdoc.Processor
Setter method for footer property.
setFooter(String) - Method in class com.xnsdoc.Task
Set the footer text to be placed at the bottom of each output file.
setHeader(String) - Method in class com.xnsdoc.Processor
Setter method for header property.
setHeader(String) - Method in class com.xnsdoc.Task
Set the header text to be placed at the top of each output file.
setHideAttributes(boolean) - Method in class com.xnsdoc.Processor
Setter method for hideAttributes property.
setHideGroups(boolean) - Method in class com.xnsdoc.Processor
Setter method for hideGroups property.
setHideNotations(boolean) - Method in class com.xnsdoc.Processor
Setter method for hideNotations property.
setHideTypes(boolean) - Method in class com.xnsdoc.Processor
Setter method for hideTypes property.
setHideattributes(boolean) - Method in class com.xnsdoc.Task
Setter method for hideAttributes property.
setHidegroups(boolean) - Method in class com.xnsdoc.Task
Setter method for hideGroups property.
setHidetypes(boolean) - Method in class com.xnsdoc.Task
Setter method for hideTypes property.
setLaunch(boolean) - Method in class com.xnsdoc.Processor
Setter method for launch property.
setLevel(int) - Method in class com.xnsdoc.ConsoleListener
 
setLevel(int) - Method in interface com.xnsdoc.ProcessorListener
Sets the verbosity level.
setLicense(String) - Method in class com.xnsdoc.Processor
Setter method for license property.
setListener(ProcessorListener) - Method in class com.xnsdoc.BaseProcessor
Setter method for the listener.
setMainSchema(Document) - Method in class com.xnsdoc.Processor
Setter method for mainSchema property.
setMaxIdLength(int) - Method in class com.xnsdoc.Processor
Setter method for the maxIfLength propety.
setOut(String) - Method in class com.xnsdoc.Processor
Setter method for out property.
setOut(String) - Method in class com.xnsdoc.Task
Setter method for out property.
setProxyHost(String) - Method in class com.xnsdoc.Processor
Setter method for proxyHost property.
setProxyPort(String) - Method in class com.xnsdoc.Processor
Setter method for proxyPort property.
setQuiet(boolean) - Method in class com.xnsdoc.Task
Setter method for quiet property.
setSchemaLocation(String) - Method in class com.xnsdoc.Processor
Setter method for schemaLocation property.
setVerbose(boolean) - Method in class com.xnsdoc.BaseProcessor
Setter method for verbose property.
setVerbose(boolean) - Method in class com.xnsdoc.Task
Setter method for verbose property.
setXml(boolean) - Method in class com.xnsdoc.Processor
Setter method for xml property.
setXml(boolean) - Method in class com.xnsdoc.Task
Setter method for xml attribute.
start(int) - Method in class com.xnsdoc.ConsoleListener
 
start(int) - Method in interface com.xnsdoc.ProcessorListener
Signals start of processing.

T

Task - class com.xnsdoc.Task.
Adapter of the Processor to Apache Ant.
Task() - Constructor for class com.xnsdoc.Task
Default constructor.
Task.Html - class com.xnsdoc.Task.Html.
An HTML fragment in a nested element of the task.
Task.Html() - Constructor for class com.xnsdoc.Task.Html
Constructs a new HTML instance.

V

VERSION - Static variable in class com.xnsdoc.Processor
version info.

W

WARN - Static variable in interface com.xnsdoc.ProcessorListener
listening level.
warn(String) - Method in class com.xnsdoc.ConsoleListener
 
warn(String) - Method in interface com.xnsdoc.ProcessorListener
Log a message with warn log level.
worked(String) - Method in class com.xnsdoc.ConsoleListener
 
worked(String) - Method in interface com.xnsdoc.ProcessorListener
Signals start of processinga component.

X

XMLNS_XS - Static variable in class com.xnsdoc.BaseProcessor
Default namespace declaration attribute nama for XML schema namespace.
XMLSCHEMA_NAMESPACE - Static variable in class com.xnsdoc.BaseProcessor
Namespace-URI of namespace of W3C-XML-Schema.

A B C D E F G I M N P R S T V W X
buldocs Ltd.
xnsdoc 1.2.1 Java API

Copyright 2005 buldocs Ltd. All rights reserved.
Use is subject to license terms.