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, wait
destinationDirectory, getDestinationDirectory, getHeader, getWindowTitle, header, setDestinationDirectory, setHeader, setWindowTitle, windowTitle
public CoreJavadocOptions()
protected CoreJavadocOptions(org.gradle.external.javadoc.internal.JavadocOptionFile optionFile)
public java.lang.String getOverview()
getOverview
in interface MinimalJavadocOptions
public void setOverview(java.lang.String overview)
setOverview
in interface MinimalJavadocOptions
public MinimalJavadocOptions overview(java.lang.String overview)
overview
in interface MinimalJavadocOptions
overview
- The new overview.MinimalJavadocOptions
object.public JavadocMemberLevel getMemberLevel()
getMemberLevel
in interface MinimalJavadocOptions
public void setMemberLevel(JavadocMemberLevel memberLevel)
setMemberLevel
in interface MinimalJavadocOptions
public MinimalJavadocOptions showFromPublic()
showFromPublic
in interface MinimalJavadocOptions
public MinimalJavadocOptions showFromProtected()
showFromProtected
in interface MinimalJavadocOptions
public MinimalJavadocOptions showFromPackage()
showFromPackage
in interface MinimalJavadocOptions
public void contributeCommandLineOptions(ExecSpec execHandleBuilder)
contributeCommandLineOptions
in interface MinimalJavadocOptions
public MinimalJavadocOptions showFromPrivate()
showFromPrivate
in interface MinimalJavadocOptions
public MinimalJavadocOptions showAll()
showAll
in interface MinimalJavadocOptions
public java.lang.String getDoclet()
getDoclet
in interface MinimalJavadocOptions
public void setDoclet(java.lang.String doclet)
setDoclet
in interface MinimalJavadocOptions
public MinimalJavadocOptions doclet(java.lang.String doclet)
doclet
in interface MinimalJavadocOptions
public java.util.List<java.io.File> getDocletpath()
getDocletpath
in interface MinimalJavadocOptions
public void setDocletpath(java.util.List<java.io.File> docletpath)
setDocletpath
in interface MinimalJavadocOptions
public MinimalJavadocOptions docletpath(java.io.File... docletpath)
docletpath
in interface MinimalJavadocOptions
public java.lang.String getSource()
getSource
in interface MinimalJavadocOptions
public void setSource(java.lang.String source)
setSource
in interface MinimalJavadocOptions
public MinimalJavadocOptions source(java.lang.String source)
source
in interface MinimalJavadocOptions
public java.util.List<java.io.File> getClasspath()
getClasspath
in interface MinimalJavadocOptions
public void setClasspath(java.util.List<java.io.File> classpath)
setClasspath
in interface MinimalJavadocOptions
public MinimalJavadocOptions classpath(java.util.List<java.io.File> classpath)
classpath
in interface MinimalJavadocOptions
public MinimalJavadocOptions classpath(java.io.File... classpath)
classpath
in interface MinimalJavadocOptions
public java.util.List<java.io.File> getBootClasspath()
getBootClasspath
in interface MinimalJavadocOptions
public void setBootClasspath(java.util.List<java.io.File> bootClasspath)
setBootClasspath
in interface MinimalJavadocOptions
public MinimalJavadocOptions bootClasspath(java.io.File... bootClasspath)
bootClasspath
in interface MinimalJavadocOptions
public java.util.List<java.io.File> getExtDirs()
getExtDirs
in interface MinimalJavadocOptions
public void setExtDirs(java.util.List<java.io.File> extDirs)
setExtDirs
in interface MinimalJavadocOptions
public MinimalJavadocOptions extDirs(java.io.File... extDirs)
extDirs
in interface MinimalJavadocOptions
public JavadocOutputLevel getOutputLevel()
getOutputLevel
in interface MinimalJavadocOptions
public void setOutputLevel(JavadocOutputLevel outputLevel)
setOutputLevel
in interface MinimalJavadocOptions
public MinimalJavadocOptions verbose()
verbose
in interface MinimalJavadocOptions
public boolean isVerbose()
isVerbose
in interface MinimalJavadocOptions
public MinimalJavadocOptions quiet()
quiet
in interface MinimalJavadocOptions
public boolean isBreakIterator()
isBreakIterator
in interface MinimalJavadocOptions
public void setBreakIterator(boolean breakIterator)
setBreakIterator
in interface MinimalJavadocOptions
public MinimalJavadocOptions breakIterator(boolean breakIterator)
breakIterator
in interface MinimalJavadocOptions
public MinimalJavadocOptions breakIterator()
breakIterator
in interface MinimalJavadocOptions
public java.lang.String getLocale()
getLocale
in interface MinimalJavadocOptions
public void setLocale(java.lang.String locale)
setLocale
in interface MinimalJavadocOptions
public MinimalJavadocOptions locale(java.lang.String locale)
locale
in interface MinimalJavadocOptions
public java.lang.String getEncoding()
getEncoding
in interface MinimalJavadocOptions
public void setEncoding(java.lang.String encoding)
setEncoding
in interface MinimalJavadocOptions
public MinimalJavadocOptions encoding(java.lang.String encoding)
encoding
in interface MinimalJavadocOptions
public java.util.List<java.lang.String> getSourceNames()
getSourceNames
in interface MinimalJavadocOptions
public void setSourceNames(java.util.List<java.lang.String> sourceNames)
setSourceNames
in interface MinimalJavadocOptions
public MinimalJavadocOptions sourceNames(java.lang.String... sourceNames)
sourceNames
in interface MinimalJavadocOptions
public java.util.List<java.lang.String> getJFlags()
getJFlags
in interface MinimalJavadocOptions
public void setJFlags(java.util.List<java.lang.String> jFlags)
setJFlags
in interface MinimalJavadocOptions
public MinimalJavadocOptions jFlags(java.lang.String... jFlags)
jFlags
in interface MinimalJavadocOptions
public java.util.List<java.io.File> getOptionFiles()
getOptionFiles
in interface MinimalJavadocOptions
public void setOptionFiles(java.util.List<java.io.File> optionFiles)
setOptionFiles
in interface MinimalJavadocOptions
public MinimalJavadocOptions optionFiles(java.io.File... argumentFiles)
optionFiles
in interface MinimalJavadocOptions
public final void write(java.io.File outputFile) throws java.io.IOException
write
in interface MinimalJavadocOptions
java.io.IOException
public <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)