public abstract class CoreJavadocOptions extends Object implements MinimalJavadocOptions
| Modifier and Type | Field and Description |
|---|---|
protected org.gradle.external.javadoc.internal.JavadocOptionFile |
optionFile |
| Modifier | Constructor and Description |
|---|---|
|
CoreJavadocOptions() |
protected |
CoreJavadocOptions(CoreJavadocOptions original,
org.gradle.external.javadoc.internal.JavadocOptionFile optionFile) |
protected |
CoreJavadocOptions(org.gradle.external.javadoc.internal.JavadocOptionFile optionFile) |
| Modifier and Type | Method and Description |
|---|---|
JavadocOptionFileOption<Boolean> |
addBooleanOption(String option) |
JavadocOptionFileOption<Boolean> |
addBooleanOption(String option,
boolean value) |
<T extends Enum<T>> |
addEnumOption(String option) |
<T extends Enum<T>> |
addEnumOption(String option,
T value) |
JavadocOptionFileOption<File> |
addFileOption(String option) |
JavadocOptionFileOption<File> |
addFileOption(String option,
File value) |
JavadocOptionFileOption<List<List<String>>> |
addMultilineMultiValueOption(String option)
Adds an option that will appear multiple times to the javadoc tool.
|
JavadocOptionFileOption<List<String>> |
addMultilineStringsOption(String option)
Adds an option that will appear multiple times to the javadoc tool.
|
<T> JavadocOptionFileOption<T> |
addOption(JavadocOptionFileOption<T> option) |
JavadocOptionFileOption<List<File>> |
addPathOption(String option) |
JavadocOptionFileOption<List<File>> |
addPathOption(String option,
String joinBy) |
JavadocOptionFileOption<String> |
addStringOption(String option) |
JavadocOptionFileOption<String> |
addStringOption(String option,
String value) |
JavadocOptionFileOption<List<String>> |
addStringsOption(String option) |
JavadocOptionFileOption<List<String>> |
addStringsOption(String option,
String joinBy)
Adds an option that will have multiple values joined by the provided separator.
|
MinimalJavadocOptions |
bootClasspath(File... bootClasspath) |
MinimalJavadocOptions |
breakIterator() |
MinimalJavadocOptions |
breakIterator(boolean breakIterator) |
MinimalJavadocOptions |
classpath(File... classpath) |
MinimalJavadocOptions |
classpath(List<File> classpath) |
void |
contributeCommandLineOptions(ExecSpec execHandleBuilder) |
MinimalJavadocOptions |
doclet(String doclet) |
MinimalJavadocOptions |
docletpath(File... docletpath) |
MinimalJavadocOptions |
encoding(String encoding) |
MinimalJavadocOptions |
extDirs(File... extDirs) |
List<File> |
getBootClasspath()
-bootclasspath classpathlist
Specifies the paths where the boot classes reside.
|
List<File> |
getClasspath()
-classpath classpathlist
Specifies the paths where javadoc will look for referenced classes (.class files)
-- these are the documented classes plus any classes referenced by those classes.
|
String |
getDoclet()
-doclet class
Specifies the class file that starts the doclet used in generating the documentation.
|
List<File> |
getDocletpath()
-docletpath classpathlist
Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on.
|
String |
getEncoding()
-encoding name
Specifies the encoding name of the source files, such as EUCJIS/SJIS.
|
List<File> |
getExtDirs()
-extdirs dirlist
Specifies the directories where extension classes reside.
|
List<String> |
getJFlags()
-Jflag
Passes flag directly to the runtime system java that runs javadoc.
|
String |
getLocale()
-locale language_country_variant
Important - The -locale option must be placed ahead (to the left) of any options provided by the standard doclet or
any other doclet.
|
JavadocMemberLevel |
getMemberLevel()
Switch to set the members that should be included in the Javadoc.
|
List<File> |
getOptionFiles() |
JavadocOutputLevel |
getOutputLevel()
Control the Javadoc output level (-verbose or -quiet).
|
String |
getOverview()
-overview path\filename
Specifies that javadoc should retrieve the text for the overview documentation from
the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
String |
getSource()
-source release
Specifies the version of source code accepted.
|
List<String> |
getSourceNames() |
boolean |
isBreakIterator()
-breakiterator
Uses the internationalized sentence boundary of java.text.BreakIterator to determine the end of the first sentence
for English (all other locales already use BreakIterator), rather than an English language, locale-specific algorithm.
|
boolean |
isVerbose() |
MinimalJavadocOptions |
jFlags(String... jFlags) |
MinimalJavadocOptions |
locale(String locale) |
MinimalJavadocOptions |
optionFiles(File... argumentFiles) |
MinimalJavadocOptions |
overview(String overview)
Fluent setter for the overview option.
|
MinimalJavadocOptions |
quiet() |
void |
setBootClasspath(List<File> bootClasspath) |
void |
setBreakIterator(boolean breakIterator) |
void |
setClasspath(List<File> classpath) |
void |
setDoclet(String doclet) |
void |
setDocletpath(List<File> docletpath) |
void |
setEncoding(String encoding) |
void |
setExtDirs(List<File> extDirs) |
void |
setJFlags(List<String> jFlags) |
void |
setLocale(String locale) |
void |
setMemberLevel(JavadocMemberLevel memberLevel) |
void |
setOptionFiles(List<File> optionFiles) |
void |
setOutputLevel(JavadocOutputLevel outputLevel) |
void |
setOverview(String overview) |
void |
setSource(String source) |
void |
setSourceNames(List<String> sourceNames) |
MinimalJavadocOptions |
showAll() |
MinimalJavadocOptions |
showFromPackage() |
MinimalJavadocOptions |
showFromPrivate() |
MinimalJavadocOptions |
showFromProtected() |
MinimalJavadocOptions |
showFromPublic() |
MinimalJavadocOptions |
source(String source) |
MinimalJavadocOptions |
sourceNames(String... sourceNames) |
MinimalJavadocOptions |
verbose() |
void |
write(File outputFile) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdestinationDirectory, getDestinationDirectory, getHeader, getWindowTitle, header, setDestinationDirectory, setHeader, setWindowTitle, windowTitleprotected final org.gradle.external.javadoc.internal.JavadocOptionFile optionFile
public CoreJavadocOptions()
protected CoreJavadocOptions(org.gradle.external.javadoc.internal.JavadocOptionFile optionFile)
protected CoreJavadocOptions(CoreJavadocOptions original, org.gradle.external.javadoc.internal.JavadocOptionFile optionFile)
public String getOverview()
getOverview in interface MinimalJavadocOptionspublic void setOverview(String overview)
setOverview in interface MinimalJavadocOptionspublic MinimalJavadocOptions overview(String overview)
overview in interface MinimalJavadocOptionsoverview - The new overview.MinimalJavadocOptions object.public JavadocMemberLevel getMemberLevel()
getMemberLevel in interface MinimalJavadocOptionspublic void setMemberLevel(JavadocMemberLevel memberLevel)
setMemberLevel in interface MinimalJavadocOptionspublic MinimalJavadocOptions showFromPublic()
showFromPublic in interface MinimalJavadocOptionspublic MinimalJavadocOptions showFromProtected()
showFromProtected in interface MinimalJavadocOptionspublic MinimalJavadocOptions showFromPackage()
showFromPackage in interface MinimalJavadocOptionspublic MinimalJavadocOptions showFromPrivate()
showFromPrivate in interface MinimalJavadocOptionspublic MinimalJavadocOptions showAll()
showAll in interface MinimalJavadocOptionspublic String getDoclet()
getDoclet in interface MinimalJavadocOptionspublic void setDoclet(String doclet)
setDoclet in interface MinimalJavadocOptionspublic MinimalJavadocOptions doclet(String doclet)
doclet in interface MinimalJavadocOptionspublic List<File> getDocletpath()
getDocletpath in interface MinimalJavadocOptionspublic void setDocletpath(List<File> docletpath)
setDocletpath in interface MinimalJavadocOptionspublic MinimalJavadocOptions docletpath(File... docletpath)
docletpath in interface MinimalJavadocOptionspublic String getSource()
getSource in interface MinimalJavadocOptionspublic void setSource(String source)
setSource in interface MinimalJavadocOptionspublic MinimalJavadocOptions source(String source)
source in interface MinimalJavadocOptionspublic List<File> getClasspath()
getClasspath in interface MinimalJavadocOptionspublic void setClasspath(List<File> classpath)
setClasspath in interface MinimalJavadocOptionspublic MinimalJavadocOptions classpath(List<File> classpath)
classpath in interface MinimalJavadocOptionspublic MinimalJavadocOptions classpath(File... classpath)
classpath in interface MinimalJavadocOptionspublic List<File> getBootClasspath()
getBootClasspath in interface MinimalJavadocOptionspublic void setBootClasspath(List<File> bootClasspath)
setBootClasspath in interface MinimalJavadocOptionspublic MinimalJavadocOptions bootClasspath(File... bootClasspath)
bootClasspath in interface MinimalJavadocOptionspublic List<File> getExtDirs()
getExtDirs in interface MinimalJavadocOptionspublic void setExtDirs(List<File> extDirs)
setExtDirs in interface MinimalJavadocOptionspublic MinimalJavadocOptions extDirs(File... extDirs)
extDirs in interface MinimalJavadocOptionspublic JavadocOutputLevel getOutputLevel()
getOutputLevel in interface MinimalJavadocOptionspublic void setOutputLevel(JavadocOutputLevel outputLevel)
setOutputLevel in interface MinimalJavadocOptionspublic MinimalJavadocOptions verbose()
verbose in interface MinimalJavadocOptionspublic boolean isVerbose()
isVerbose in interface MinimalJavadocOptionspublic MinimalJavadocOptions quiet()
quiet in interface MinimalJavadocOptionspublic boolean isBreakIterator()
. * Breakiterator sentence-break algorithm - In general, stops at a period, question mark or exclamation mark followed by a space if the next word starts with a capital letter. This is meant to handle most abbreviations (such as "The serial no. is valid", but won't handle "Mr. Smith"). Doesn't stop at HTML tags or sentences that begin with numbers or symbols. Stops at the last period in "../filename", even if embedded in an HTML tag. NOTE: We have removed from 1.5.0 the breakiterator warning messages that were in 1.4.x and have left the default sentence-break algorithm unchanged. That is, the -breakiterator option is not the default in 1.5.0, nor do we expect it to become the default. This is a reversal from our former intention that the default would change in the "next major release" (1.5.0). This means if you have not modified your source code to eliminate the breakiterator warnings in 1.4.x, then you don't have to do anything, and the warnings go away starting with 1.5.0. The reason for this reversal is because any benefit to having breakiterator become the default would be outweighed by the incompatible source change it would require. We regret any extra work and confusion this has caused.
isBreakIterator in interface MinimalJavadocOptionspublic void setBreakIterator(boolean breakIterator)
setBreakIterator in interface MinimalJavadocOptionspublic MinimalJavadocOptions breakIterator(boolean breakIterator)
breakIterator in interface MinimalJavadocOptionspublic MinimalJavadocOptions breakIterator()
breakIterator in interface MinimalJavadocOptionspublic String getLocale()
getLocale in interface MinimalJavadocOptionspublic void setLocale(String locale)
setLocale in interface MinimalJavadocOptionspublic MinimalJavadocOptions locale(String locale)
locale in interface MinimalJavadocOptionspublic String getEncoding()
getEncoding in interface MinimalJavadocOptionspublic void setEncoding(String encoding)
setEncoding in interface MinimalJavadocOptionspublic MinimalJavadocOptions encoding(String encoding)
encoding in interface MinimalJavadocOptionspublic List<String> getSourceNames()
getSourceNames in interface MinimalJavadocOptionspublic void setSourceNames(List<String> sourceNames)
setSourceNames in interface MinimalJavadocOptionspublic MinimalJavadocOptions sourceNames(String... sourceNames)
sourceNames in interface MinimalJavadocOptionspublic List<String> getJFlags()
getJFlags in interface MinimalJavadocOptionspublic void setJFlags(List<String> jFlags)
setJFlags in interface MinimalJavadocOptionspublic MinimalJavadocOptions jFlags(String... jFlags)
jFlags in interface MinimalJavadocOptionspublic void contributeCommandLineOptions(ExecSpec execHandleBuilder)
contributeCommandLineOptions in interface MinimalJavadocOptionspublic List<File> getOptionFiles()
getOptionFiles in interface MinimalJavadocOptionspublic void setOptionFiles(List<File> optionFiles)
setOptionFiles in interface MinimalJavadocOptionspublic MinimalJavadocOptions optionFiles(File... argumentFiles)
optionFiles in interface MinimalJavadocOptionspublic final void write(File outputFile) throws IOException
write in interface MinimalJavadocOptionsIOExceptionpublic <T> JavadocOptionFileOption<T> addOption(JavadocOptionFileOption<T> option)
public JavadocOptionFileOption<String> addStringOption(String option)
public JavadocOptionFileOption<String> addStringOption(String option, String value)
public <T extends Enum<T>> JavadocOptionFileOption<T> addEnumOption(String option)
public <T extends Enum<T>> JavadocOptionFileOption<T> addEnumOption(String option, T value)
public JavadocOptionFileOption<List<File>> addPathOption(String option)
public JavadocOptionFileOption<List<File>> addPathOption(String option, String joinBy)
public JavadocOptionFileOption<List<String>> addStringsOption(String option)
public JavadocOptionFileOption<List<String>> addStringsOption(String option, String joinBy)
addStringsOption("foo", ",").setValue(["a", "b", "c"]) will produce the command-line
-foo 'a,b,c'
option - command-line optionjoinBy - separatorpublic JavadocOptionFileOption<List<String>> addMultilineStringsOption(String option)
addMultilineStringsOption("foo").setValue(["a", "b", "c"]) will produce the command-line
-foo 'a'
-foo 'b'
-foo 'c'
option - command-line optionpublic JavadocOptionFileOption<List<List<String>>> addMultilineMultiValueOption(String option)
addMultilineMultiValueOption("foo").setValue([ ["a"], ["b", "c"] ]) will produce the command-line
-foo 'a'
-foo 'b' 'c'
option - command-line optionpublic JavadocOptionFileOption<Boolean> addBooleanOption(String option)
public JavadocOptionFileOption<Boolean> addBooleanOption(String option, boolean value)
public JavadocOptionFileOption<File> addFileOption(String option)
public JavadocOptionFileOption<File> addFileOption(String option, File value)