Java Doc for ConfigurationImpl.java in » 6.0-JDK-Modules-com.sun » tools » com » sun » tools » doclets » formats » html » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » 6.0 JDK Modules com.sun » tools » com.sun.tools.doclets.formats.html

Source Cross Reference

Class Diagram

Java Document (Java Doc)

java.lang .Object

com.sun.tools.doclets.internal.toolkit .Configuration

com.sun.tools.doclets.formats.html .ConfigurationImpl

ConfigurationImpl

public class ConfigurationImpl extends Configuration (Code)

Configure the output based on the command line options.

Also determine the length of the command line option. For example, for a option "-header" there will be a string argument associated, then the the length of option "-header" is two. But for option "-nohelp" no argument is needed so it's length is 1.

Also do the error checking on the options used. For example it is illegal to use "-helpfile" option when already "-nohelp" option is used.

author:
   Robert Field.
author:
   Atul Dambalkar.
author:
   Jamie Ho

Field Summary
final public static String	BUILD_DATE The build date.
final public static String	CONSTANTS_FILE_NAME The name of the constant values file.
public String	bottom Argument for command line option "-bottom".
public boolean	classuse True if command line option "-use" is used.
public boolean	createindex False if command line option "-noindex" is used.
public boolean	createoverview This is true if option "-overview" is used or option "-overview" is not used and number of packages is more than one.
public boolean	createtree False if command line option "-notree" is used.
public ClassDoc	currentcd The classdoc for the class file getting generated.
public String	doctitle Argument for command line option "-doctitle".
public String	footer Argument for command line option "-footer".
public String	header Argument for command line option "-header".
public String	helpfile Argument for command line option "-helpfile".
public boolean	nodeprecatedlist True if command line option "-nodeprecated" is used.
public boolean	nohelp True if command line option "-nohelp" is used.
public boolean	nonavbar True if command line option "-nonavbar" is used.
public boolean	overview True if command line option "-overview" is used.
public String	packagesheader Argument for command line option "-packagesheader".
public boolean	splitindex True if command line option "-splitindex" is used.
final public MessageRetriever	standardmessage Unique Resource Handler for this package.
public String	stylesheetfile Argument for command line option "-stylesheetfile".
public String	top Argument for command line option "-top".
public String	topFile First file to appear in the right-hand frame in the generated documentation.
public String	windowtitle Argument for command line option "-windowtitle".

Method Summary
protected boolean	checkForDeprecation(RootDoc root)
public String	getDocletSpecificBuildDate() Return the build date for the doclet.
public MessageRetriever	getDocletSpecificMsg()
public static ConfigurationImpl	getInstance()
public Comparator	getMemberComparator()
protected ClassDoc	getValidClass(ClassDoc[] classarr)
public WriterFactory	getWriterFactory()
public int	optionLength(String option) Returns the "length" of a given option.
protected void	setCreateOverview() Generate "overview.html" page if option "-overview" is used or number of packages is more than one.
public void	setSpecificDocletOptions(String[][] options) Depending upon the command line options provided by the user, set configure the output generation environment.
protected void	setTopFile(RootDoc root) Decide the page which will appear first in the right-hand frame.
public boolean	validOptions(String options, DocErrorReporter reporter)

Field Detail

BUILD_DATE
final public static String BUILD_DATE(Code)
	The build date. Note: For now, we will use a version number instead of a date.

CONSTANTS_FILE_NAME
final public static String CONSTANTS_FILE_NAME(Code)
	The name of the constant values file.

bottom
public String bottom(Code)
	Argument for command line option "-bottom".

classuse
public boolean classuse(Code)
	True if command line option "-use" is used. Default value is false.

createindex
public boolean createindex(Code)
	False if command line option "-noindex" is used. Default value is true.

createoverview
public boolean createoverview(Code)
	This is true if option "-overview" is used or option "-overview" is not used and number of packages is more than one.

createtree
public boolean createtree(Code)
	False if command line option "-notree" is used. Default value is true.

currentcd
public ClassDoc currentcd(Code)
	The classdoc for the class file getting generated.

doctitle
public String doctitle(Code)
	Argument for command line option "-doctitle".

footer
public String footer(Code)
	Argument for command line option "-footer".

header
public String header(Code)
	Argument for command line option "-header".

helpfile
public String helpfile(Code)
	Argument for command line option "-helpfile".

nodeprecatedlist
public boolean nodeprecatedlist(Code)
	True if command line option "-nodeprecated" is used. Default value is false.

nohelp
public boolean nohelp(Code)
	True if command line option "-nohelp" is used. Default value is false.

nonavbar
public boolean nonavbar(Code)
	True if command line option "-nonavbar" is used. Default value is false.

overview
public boolean overview(Code)
	True if command line option "-overview" is used. Default value is false.

packagesheader
public String packagesheader(Code)
	Argument for command line option "-packagesheader".

splitindex
public boolean splitindex(Code)
	True if command line option "-splitindex" is used. Default value is false.

standardmessage
final public MessageRetriever standardmessage(Code)
	Unique Resource Handler for this package.

stylesheetfile
public String stylesheetfile(Code)
	Argument for command line option "-stylesheetfile".

top
public String top(Code)
	Argument for command line option "-top".

topFile
public String topFile(Code)
	First file to appear in the right-hand frame in the generated documentation.

windowtitle
public String windowtitle(Code)
	Argument for command line option "-windowtitle".

Method Detail

checkForDeprecation
protected boolean checkForDeprecation(RootDoc root)(Code)

getDocletSpecificBuildDate
public String getDocletSpecificBuildDate()(Code)
	Return the build date for the doclet.

getDocletSpecificMsg
public MessageRetriever getDocletSpecificMsg()(Code)

getInstance
public static ConfigurationImpl getInstance()(Code)

getMemberComparator
public Comparator getMemberComparator()(Code)

getValidClass
protected ClassDoc getValidClass(ClassDoc[] classarr)(Code)

getWriterFactory
public WriterFactory getWriterFactory()(Code)

optionLength
public int optionLength(String option)(Code)
	Returns the "length" of a given option. If an option takes no arguments, its length is one. If it takes one argument, it's length is two, and so on. This method is called by JavaDoc to parse the options it does not recognize. It then calls ConfigurationImpl.validOptions(String[][],DocErrorReporter) to validate them. Note: The options arrive as case-sensitive strings. For options that are not case-sensitive, use toLowerCase() on the option string before comparing it. number of arguments + 1 for a option. Zero return meansoption not known. Negative value means error occurred.

setCreateOverview
protected void setCreateOverview()(Code)
	Generate "overview.html" page if option "-overview" is used or number of packages is more than one. Sets ConfigurationImpl.createoverview field to true.

setSpecificDocletOptions
public void setSpecificDocletOptions(String[][] options)(Code)
	Depending upon the command line options provided by the user, set configure the output generation environment. Parameters: options - The array of option names and values.

setTopFile
protected void setTopFile(RootDoc root)(Code)
	Decide the page which will appear first in the right-hand frame. It will be "overview-summary.html" if "-overview" option is used or no "-overview" but the number of packages is more than one. It will be "package-summary.html" of the respective package if there is only one package to document. It will be a class page(first in the sorted order), if only classes are provided on the command line. Parameters: root - Root of the program structure.

validOptions
public boolean validOptions(String options, DocErrorReporter reporter)(Code)

Fields inherited from com.sun.tools.doclets.internal.toolkit.Configuration

protected BuilderFactory builderFactory(Code)(Java Doc)
public String builderXMLPath(Code)(Java Doc)
public String charset(Code)(Java Doc)
public ClassDocCatalog classDocCatalog(Code)(Java Doc)
public boolean copydocfilesubdirs(Code)(Java Doc)
public String destDirName(Code)(Java Doc)
public String docFileDestDirName(Code)(Java Doc)
public String docencoding(Code)(Java Doc)
public String encoding(Code)(Java Doc)
protected Set excludedDocFileDirs(Code)(Java Doc)
protected Set excludedQualifiers(Code)(Java Doc)
final public Extern extern(Code)(Java Doc)
final public Group group(Code)(Java Doc)
public boolean keywords(Code)(Java Doc)
public boolean linksource(Code)(Java Doc)
public MessageRetriever message(Code)(Java Doc)
final public MetaKeywords metakeywords(Code)(Java Doc)
public boolean nocomment(Code)(Java Doc)
public boolean nodeprecated(Code)(Java Doc)
public boolean nosince(Code)(Java Doc)
public boolean notimestamp(Code)(Java Doc)
public PackageDoc[] packages(Code)(Java Doc)
public RootDoc root(Code)(Java Doc)
public boolean serialwarn(Code)(Java Doc)
public boolean showauthor(Code)(Java Doc)
public boolean showversion(Code)(Java Doc)
public String sourcepath(Code)(Java Doc)
public int sourcetab(Code)(Java Doc)
public TagletManager tagletManager(Code)(Java Doc)
public String tagletpath(Code)(Java Doc)

Methods inherited from com.sun.tools.doclets.internal.toolkit.Configuration

public boolean generalValidOptions(String options, DocErrorReporter reporter)(Code)(Java Doc)
public BuilderFactory getBuilderFactory()(Code)(Java Doc)
public InputStream getBuilderXML() throws FileNotFoundException(Code)(Java Doc)
public String getClassName(ClassDoc cd)(Code)(Java Doc)
abstract public String getDocletSpecificBuildDate()(Code)(Java Doc)
abstract public MessageRetriever getDocletSpecificMsg()(Code)(Java Doc)
abstract public Comparator getMemberComparator()(Code)(Java Doc)
public String getText(String key)(Code)(Java Doc)
public String getText(String key, String a1)(Code)(Java Doc)
public String getText(String key, String a1, String a2)(Code)(Java Doc)
public String getText(String key, String a1, String a2, String a3)(Code)(Java Doc)
abstract public WriterFactory getWriterFactory()(Code)(Java Doc)
public boolean isGeneratedDoc(Doc doc)(Code)(Java Doc)
public int optionLength(String option)(Code)(Java Doc)
public void setOptions(String[][] options)(Code)(Java Doc)
public void setOptions()(Code)(Java Doc)
abstract public void setSpecificDocletOptions(String[][] options)(Code)(Java Doc)
public boolean shouldExcludeDocFileDir(String docfilesubdir)(Code)(Java Doc)
public boolean shouldExcludeQualifier(String qualifier)(Code)(Java Doc)
abstract public boolean validOptions(String options, DocErrorReporter reporter)(Code)(Java Doc)

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.