CoreJavadocOptions (Gradle API 2.12)

org.gradle.external.javadoc.CoreJavadocOptions

All Implemented Interfaces and Traits:

MinimalJavadocOptions
```
public abstract class CoreJavadocOptions
extends Object
```
Provides the core Javadoc Options. That is, provides the options which are not doclet specific.

Constructor Summary

Constructors
Constructor and description
`CoreJavadocOptions ()`
`protected CoreJavadocOptions (org.gradle.external.javadoc.internal.JavadocOptionFile optionFile)`

Methods Summary

Methods
Type	Name and description
`JavadocOptionFileOption<Boolean>`	`addBooleanOption(String option)`
`JavadocOptionFileOption<Boolean>`	`addBooleanOption(String option, boolean value)`
`JavadocOptionFileOption<T>`	`addEnumOption(String option)`
`JavadocOptionFileOption<T>`	`addEnumOption(String option, T value)`
`JavadocOptionFileOption<File>`	`addFileOption(String option)`
`JavadocOptionFileOption<File>`	`addFileOption(String option, File value)`
`JavadocOptionFileOption<List<String>>`	`addMultilineStringsOption(String option)`
`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)`
`MinimalJavadocOptions`	`bootClasspath(File... bootClasspath)`
`MinimalJavadocOptions`	`breakIterator(boolean breakIterator)`
`MinimalJavadocOptions`	`breakIterator()`
`MinimalJavadocOptions`	`classpath(List<File> classpath)`
`MinimalJavadocOptions`	`classpath(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()`
`List<File>`	`getClasspath()`
`String`	`getDoclet()`
`List<File>`	`getDocletpath()`
`String`	`getEncoding()`
`List<File>`	`getExtDirs()`
`List<String>`	`getJFlags()`
`String`	`getLocale()`
`JavadocMemberLevel`	`getMemberLevel()`
`List<File>`	`getOptionFiles()`
`JavadocOutputLevel`	`getOutputLevel()`
`String`	`getOverview()`
`String`	`getSource()`
`List<String>`	`getSourceNames()`
`boolean`	`isBreakIterator()`
`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)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Constructor Detail
  - public CoreJavadocOptions()
  - protected CoreJavadocOptions(org.gradle.external.javadoc.internal.JavadocOptionFile optionFile)
- Method Detail
  - public JavadocOptionFileOption<Boolean> addBooleanOption(String option)
  - public JavadocOptionFileOption<Boolean> addBooleanOption(String option, boolean value)
  - public JavadocOptionFileOption<T> addEnumOption(String option)
  - public JavadocOptionFileOption<T> addEnumOption(String option, T value)
  - public JavadocOptionFileOption<File> addFileOption(String option)
  - public JavadocOptionFileOption<File> addFileOption(String option, File value)
  - public JavadocOptionFileOption<List<String>> addMultilineStringsOption(String option)
  - public JavadocOptionFileOption<T> addOption(JavadocOptionFileOption<T> option)
  - public JavadocOptionFileOption<List<File>> addPathOption(String option)
  - public JavadocOptionFileOption<List<File>> addPathOption(String option, String joinBy)
  - public JavadocOptionFileOption<String> addStringOption(String option)
  - public JavadocOptionFileOption<String> addStringOption(String option, String value)
  - public JavadocOptionFileOption<List<String>> addStringsOption(String option)
  - public JavadocOptionFileOption<List<String>> addStringsOption(String option, String joinBy)
  - @Override public MinimalJavadocOptions bootClasspath(File... bootClasspath)
  - @Override public MinimalJavadocOptions breakIterator(boolean breakIterator)
  - @Override public MinimalJavadocOptions breakIterator()
  - @Override public MinimalJavadocOptions classpath(List<File> classpath)
  - @Override public MinimalJavadocOptions classpath(File... classpath)
  - @Override public void contributeCommandLineOptions(ExecSpec execHandleBuilder)
  - @Override public MinimalJavadocOptions doclet(String doclet)
  - @Override public MinimalJavadocOptions docletpath(File... docletpath)
  - @Override public MinimalJavadocOptions encoding(String encoding)
  - @Override public MinimalJavadocOptions extDirs(File... extDirs)
  - @Override public List<File> getBootClasspath()
  - @Override public List<File> getClasspath()
  - @Override public String getDoclet()
  - @Override public List<File> getDocletpath()
  - @Override public String getEncoding()
  - @Override public List<File> getExtDirs()
  - @Override public List<String> getJFlags()
  - @Override public String getLocale()
  - @Override public JavadocMemberLevel getMemberLevel()
  - @Override public List<File> getOptionFiles()
  - @Override public JavadocOutputLevel getOutputLevel()
  - @Override public String getOverview()
  - @Override public String getSource()
  - @Override public List<String> getSourceNames()
  - @Override public boolean isBreakIterator()
  - @Override public boolean isVerbose()
  - @Override public MinimalJavadocOptions jFlags(String... jFlags)
  - @Override public MinimalJavadocOptions locale(String locale)
  - @Override public MinimalJavadocOptions optionFiles(File... argumentFiles)
  - @Override public MinimalJavadocOptions overview(String overview)
    
    Fluent setter for the overview option.
    Parameters:
    overview - The new overview.
    Returns:
    The MinimalJavadocOptions object.
  - @Override public MinimalJavadocOptions quiet()
  - @Override public void setBootClasspath(List<File> bootClasspath)
  - @Override public void setBreakIterator(boolean breakIterator)
  - @Override public void setClasspath(List<File> classpath)
  - @Override public void setDoclet(String doclet)
  - @Override public void setDocletpath(List<File> docletpath)
  - @Override public void setEncoding(String encoding)
  - @Override public void setExtDirs(List<File> extDirs)
  - @Override public void setJFlags(List<String> jFlags)
  - @Override public void setLocale(String locale)
  - @Override public void setMemberLevel(JavadocMemberLevel memberLevel)
  - @Override public void setOptionFiles(List<File> optionFiles)
  - @Override public void setOutputLevel(JavadocOutputLevel outputLevel)
  - @Override public void setOverview(String overview)
  - @Override public void setSource(String source)
  - @Override public void setSourceNames(List<String> sourceNames)
  - @Override public MinimalJavadocOptions showAll()
  - @Override public MinimalJavadocOptions showFromPackage()
  - @Override public MinimalJavadocOptions showFromPrivate()
  - @Override public MinimalJavadocOptions showFromProtected()
  - @Override public MinimalJavadocOptions showFromPublic()
  - @Override public MinimalJavadocOptions source(String source)
  - @Override public MinimalJavadocOptions sourceNames(String... sourceNames)
  - @Override public MinimalJavadocOptions verbose()
  - @Override public final void write(File outputFile)

Summary:
Constructor
Method

| Detail:
Constructor
Method

Gradle API 2.12

[Java] Class CoreJavadocOptions

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

public CoreJavadocOptions()

protected CoreJavadocOptions(org.gradle.external.javadoc.internal.JavadocOptionFile optionFile)

Method Detail

public JavadocOptionFileOption<Boolean> addBooleanOption(String option)

public JavadocOptionFileOption<Boolean> addBooleanOption(String option, boolean value)

public JavadocOptionFileOption<T> addEnumOption(String option)

public JavadocOptionFileOption<T> addEnumOption(String option, T value)

public JavadocOptionFileOption<File> addFileOption(String option)

public JavadocOptionFileOption<File> addFileOption(String option, File value)

public JavadocOptionFileOption<List<String>> addMultilineStringsOption(String option)

public JavadocOptionFileOption<T> addOption(JavadocOptionFileOption<T> option)

public JavadocOptionFileOption<List<File>> addPathOption(String option)

public JavadocOptionFileOption<List<File>> addPathOption(String option, String joinBy)

public JavadocOptionFileOption<String> addStringOption(String option)

public JavadocOptionFileOption<String> addStringOption(String option, String value)

public JavadocOptionFileOption<List<String>> addStringsOption(String option)

public JavadocOptionFileOption<List<String>> addStringsOption(String option, String joinBy)

@Override public MinimalJavadocOptions bootClasspath(File... bootClasspath)

@Override public MinimalJavadocOptions breakIterator(boolean breakIterator)

@Override public MinimalJavadocOptions breakIterator()

@Override public MinimalJavadocOptions classpath(List<File> classpath)

@Override public MinimalJavadocOptions classpath(File... classpath)

@Override public void contributeCommandLineOptions(ExecSpec execHandleBuilder)

@Override public MinimalJavadocOptions doclet(String doclet)

@Override public MinimalJavadocOptions docletpath(File... docletpath)

@Override public MinimalJavadocOptions encoding(String encoding)

@Override public MinimalJavadocOptions extDirs(File... extDirs)

@Override public List<File> getBootClasspath()

@Override public List<File> getClasspath()

@Override public String getDoclet()

@Override public List<File> getDocletpath()

@Override public String getEncoding()

@Override public List<File> getExtDirs()

@Override public List<String> getJFlags()

@Override public String getLocale()

@Override public JavadocMemberLevel getMemberLevel()

@Override public List<File> getOptionFiles()

@Override public JavadocOutputLevel getOutputLevel()

@Override public String getOverview()

@Override public String getSource()

@Override public List<String> getSourceNames()

@Override public boolean isBreakIterator()

@Override public boolean isVerbose()

@Override public MinimalJavadocOptions jFlags(String... jFlags)

@Override public MinimalJavadocOptions locale(String locale)

@Override public MinimalJavadocOptions optionFiles(File... argumentFiles)

@Override public MinimalJavadocOptions overview(String overview)

@Override public MinimalJavadocOptions quiet()

@Override public void setBootClasspath(List<File> bootClasspath)

@Override public void setBreakIterator(boolean breakIterator)

@Override public void setClasspath(List<File> classpath)

@Override public void setDoclet(String doclet)

@Override public void setDocletpath(List<File> docletpath)

@Override public void setEncoding(String encoding)

@Override public void setExtDirs(List<File> extDirs)

@Override public void setJFlags(List<String> jFlags)

@Override public void setLocale(String locale)

@Override public void setMemberLevel(JavadocMemberLevel memberLevel)

@Override public void setOptionFiles(List<File> optionFiles)

@Override public void setOutputLevel(JavadocOutputLevel outputLevel)

@Override public void setOverview(String overview)

@Override public void setSource(String source)

@Override public void setSourceNames(List<String> sourceNames)

@Override public MinimalJavadocOptions showAll()

@Override public MinimalJavadocOptions showFromPackage()

@Override public MinimalJavadocOptions showFromPrivate()

@Override public MinimalJavadocOptions showFromProtected()

@Override public MinimalJavadocOptions showFromPublic()

@Override public MinimalJavadocOptions source(String source)

@Override public MinimalJavadocOptions sourceNames(String... sourceNames)

@Override public MinimalJavadocOptions verbose()

@Override public final void write(File outputFile)