public abstract class CoreJavadocOptions extends java.lang.Object implements MinimalJavadocOptions
| Modifier | Constructor and Description |
|---|---|
|
CoreJavadocOptions() |
protected |
CoreJavadocOptions(org.gradle.external.javadoc.internal.JavadocOptionFile optionFile) |
| Modifier and Type | Method and Description |
|---|---|
JavadocOptionFileOption<java.lang.Boolean> |
addBooleanOption(java.lang.String option) |
JavadocOptionFileOption<java.lang.Boolean> |
addBooleanOption(java.lang.String option,
boolean value) |
<T extends java.lang.Enum<T>> |
addEnumOption(java.lang.String option) |
<T extends java.lang.Enum<T>> |
addEnumOption(java.lang.String option,
T value) |
JavadocOptionFileOption<java.io.File> |
addFileOption(java.lang.String option) |
JavadocOptionFileOption<java.io.File> |
addFileOption(java.lang.String option,
java.io.File value) |
JavadocOptionFileOption<java.util.List<java.lang.String>> |
addMultilineStringsOption(java.lang.String option) |
<T> JavadocOptionFileOption<T> |
addOption(JavadocOptionFileOption<T> option) |
JavadocOptionFileOption<java.util.List<java.io.File>> |
addPathOption(java.lang.String option) |
JavadocOptionFileOption<java.util.List<java.io.File>> |
addPathOption(java.lang.String option,
java.lang.String joinBy) |
JavadocOptionFileOption<java.lang.String> |
addStringOption(java.lang.String option) |
JavadocOptionFileOption<java.lang.String> |
addStringOption(java.lang.String option,
java.lang.String value) |
JavadocOptionFileOption<java.util.List<java.lang.String>> |
addStringsOption(java.lang.String option) |
JavadocOptionFileOption<java.util.List<java.lang.String>> |
addStringsOption(java.lang.String option,
java.lang.String joinBy) |
MinimalJavadocOptions |
bootClasspath(java.io.File... bootClasspath) |
MinimalJavadocOptions |
breakIterator() |
MinimalJavadocOptions |
breakIterator(boolean breakIterator) |
MinimalJavadocOptions |
classpath(java.io.File... classpath) |
MinimalJavadocOptions |
classpath(java.util.List<java.io.File> classpath) |
void |
contributeCommandLineOptions(ExecSpec execHandleBuilder) |
MinimalJavadocOptions |
doclet(java.lang.String doclet) |
MinimalJavadocOptions |
docletpath(java.io.File... docletpath) |
MinimalJavadocOptions |
encoding(java.lang.String encoding) |
MinimalJavadocOptions |
extDirs(java.io.File... extDirs) |
java.util.List<java.io.File> |
getBootClasspath() |
java.util.List<java.io.File> |
getClasspath() |
java.lang.String |
getDoclet() |
java.util.List<java.io.File> |
getDocletpath() |
java.lang.String |
getEncoding() |
java.util.List<java.io.File> |
getExtDirs() |
java.util.List<java.lang.String> |
getJFlags() |
java.lang.String |
getLocale() |
JavadocMemberLevel |
getMemberLevel() |
java.util.List<java.io.File> |
getOptionFiles() |
JavadocOutputLevel |
getOutputLevel() |
java.lang.String |
getOverview() |
java.lang.String |
getSource() |
java.util.List<java.lang.String> |
getSourceNames() |
boolean |
isBreakIterator() |
boolean |
isVerbose() |
MinimalJavadocOptions |
jFlags(java.lang.String... jFlags) |
MinimalJavadocOptions |
locale(java.lang.String locale) |
MinimalJavadocOptions |
optionFiles(java.io.File... argumentFiles) |
MinimalJavadocOptions |
overview(java.lang.String overview)
Fluent setter for the overview option.
|
MinimalJavadocOptions |
quiet() |
void |
setBootClasspath(java.util.List<java.io.File> bootClasspath) |
void |
setBreakIterator(boolean breakIterator) |
void |
setClasspath(java.util.List<java.io.File> classpath) |
void |
setDoclet(java.lang.String doclet) |
void |
setDocletpath(java.util.List<java.io.File> docletpath) |
void |
setEncoding(java.lang.String encoding) |
void |
setExtDirs(java.util.List<java.io.File> extDirs) |
void |
setJFlags(java.util.List<java.lang.String> jFlags) |
void |
setLocale(java.lang.String locale) |
void |
setMemberLevel(JavadocMemberLevel memberLevel) |
void |
setOptionFiles(java.util.List<java.io.File> optionFiles) |
void |
setOutputLevel(JavadocOutputLevel outputLevel) |
void |
setOverview(java.lang.String overview) |
void |
setSource(java.lang.String source) |
void |
setSourceNames(java.util.List<java.lang.String> sourceNames) |
MinimalJavadocOptions |
showAll() |
MinimalJavadocOptions |
showFromPackage() |
MinimalJavadocOptions |
showFromPrivate() |
MinimalJavadocOptions |
showFromProtected() |
MinimalJavadocOptions |
showFromPublic() |
MinimalJavadocOptions |
source(java.lang.String source) |
MinimalJavadocOptions |
sourceNames(java.lang.String... sourceNames) |
MinimalJavadocOptions |
verbose() |
void |
write(java.io.File outputFile) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdestinationDirectory, getDestinationDirectory, getHeader, getWindowTitle, header, setDestinationDirectory, setHeader, setWindowTitle, windowTitlepublic CoreJavadocOptions()
protected CoreJavadocOptions(org.gradle.external.javadoc.internal.JavadocOptionFile optionFile)
public java.lang.String getOverview()
getOverview in interface MinimalJavadocOptionspublic void setOverview(java.lang.String overview)
setOverview in interface MinimalJavadocOptionspublic MinimalJavadocOptions overview(java.lang.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 void contributeCommandLineOptions(ExecSpec execHandleBuilder)
contributeCommandLineOptions in interface MinimalJavadocOptionspublic MinimalJavadocOptions showFromPrivate()
showFromPrivate in interface MinimalJavadocOptionspublic MinimalJavadocOptions showAll()
showAll in interface MinimalJavadocOptionspublic java.lang.String getDoclet()
getDoclet in interface MinimalJavadocOptionspublic void setDoclet(java.lang.String doclet)
setDoclet in interface MinimalJavadocOptionspublic MinimalJavadocOptions doclet(java.lang.String doclet)
doclet in interface MinimalJavadocOptionspublic java.util.List<java.io.File> getDocletpath()
getDocletpath in interface MinimalJavadocOptionspublic void setDocletpath(java.util.List<java.io.File> docletpath)
setDocletpath in interface MinimalJavadocOptionspublic MinimalJavadocOptions docletpath(java.io.File... docletpath)
docletpath in interface MinimalJavadocOptionspublic java.lang.String getSource()
getSource in interface MinimalJavadocOptionspublic void setSource(java.lang.String source)
setSource in interface MinimalJavadocOptionspublic MinimalJavadocOptions source(java.lang.String source)
source in interface MinimalJavadocOptionspublic java.util.List<java.io.File> getClasspath()
getClasspath in interface MinimalJavadocOptionspublic void setClasspath(java.util.List<java.io.File> classpath)
setClasspath in interface MinimalJavadocOptionspublic MinimalJavadocOptions classpath(java.util.List<java.io.File> classpath)
classpath in interface MinimalJavadocOptionspublic MinimalJavadocOptions classpath(java.io.File... classpath)
classpath in interface MinimalJavadocOptionspublic java.util.List<java.io.File> getBootClasspath()
getBootClasspath in interface MinimalJavadocOptionspublic void setBootClasspath(java.util.List<java.io.File> bootClasspath)
setBootClasspath in interface MinimalJavadocOptionspublic MinimalJavadocOptions bootClasspath(java.io.File... bootClasspath)
bootClasspath in interface MinimalJavadocOptionspublic java.util.List<java.io.File> getExtDirs()
getExtDirs in interface MinimalJavadocOptionspublic void setExtDirs(java.util.List<java.io.File> extDirs)
setExtDirs in interface MinimalJavadocOptionspublic MinimalJavadocOptions extDirs(java.io.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()
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 java.lang.String getLocale()
getLocale in interface MinimalJavadocOptionspublic void setLocale(java.lang.String locale)
setLocale in interface MinimalJavadocOptionspublic MinimalJavadocOptions locale(java.lang.String locale)
locale in interface MinimalJavadocOptionspublic java.lang.String getEncoding()
getEncoding in interface MinimalJavadocOptionspublic void setEncoding(java.lang.String encoding)
setEncoding in interface MinimalJavadocOptionspublic MinimalJavadocOptions encoding(java.lang.String encoding)
encoding in interface MinimalJavadocOptionspublic java.util.List<java.lang.String> getSourceNames()
getSourceNames in interface MinimalJavadocOptionspublic void setSourceNames(java.util.List<java.lang.String> sourceNames)
setSourceNames in interface MinimalJavadocOptionspublic MinimalJavadocOptions sourceNames(java.lang.String... sourceNames)
sourceNames in interface MinimalJavadocOptionspublic java.util.List<java.lang.String> getJFlags()
getJFlags in interface MinimalJavadocOptionspublic void setJFlags(java.util.List<java.lang.String> jFlags)
setJFlags in interface MinimalJavadocOptionspublic MinimalJavadocOptions jFlags(java.lang.String... jFlags)
jFlags in interface MinimalJavadocOptionspublic java.util.List<java.io.File> getOptionFiles()
getOptionFiles in interface MinimalJavadocOptionspublic void setOptionFiles(java.util.List<java.io.File> optionFiles)
setOptionFiles in interface MinimalJavadocOptionspublic MinimalJavadocOptions optionFiles(java.io.File... argumentFiles)
optionFiles in interface MinimalJavadocOptionspublic final void write(java.io.File outputFile)
throws java.io.IOException
write in interface MinimalJavadocOptionsjava.io.IOExceptionpublic <T> JavadocOptionFileOption<T> addOption(JavadocOptionFileOption<T> option)
public JavadocOptionFileOption<java.lang.String> addStringOption(java.lang.String option)
public JavadocOptionFileOption<java.lang.String> addStringOption(java.lang.String option, java.lang.String value)
public <T extends java.lang.Enum<T>> JavadocOptionFileOption<T> addEnumOption(java.lang.String option)
public <T extends java.lang.Enum<T>> JavadocOptionFileOption<T> addEnumOption(java.lang.String option, T value)
public JavadocOptionFileOption<java.util.List<java.io.File>> addPathOption(java.lang.String option)
public JavadocOptionFileOption<java.util.List<java.io.File>> addPathOption(java.lang.String option, java.lang.String joinBy)
public JavadocOptionFileOption<java.util.List<java.lang.String>> addStringsOption(java.lang.String option)
public JavadocOptionFileOption<java.util.List<java.lang.String>> addStringsOption(java.lang.String option, java.lang.String joinBy)
public JavadocOptionFileOption<java.util.List<java.lang.String>> addMultilineStringsOption(java.lang.String option)
public JavadocOptionFileOption<java.lang.Boolean> addBooleanOption(java.lang.String option)
public JavadocOptionFileOption<java.lang.Boolean> addBooleanOption(java.lang.String option, boolean value)
public JavadocOptionFileOption<java.io.File> addFileOption(java.lang.String option)
public JavadocOptionFileOption<java.io.File> addFileOption(java.lang.String option, java.io.File value)