Overview | Package | Class | Deprecated | Index | Help
| Groovy Documentation
| FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.gradle.external.javadoc
[Java] Class CoreJavadocOptions

    java.lang.Object
      org.gradle.external.javadoc.CoreJavadocOptions

All Implemented Interfaces:
  MinimalJavadocOptions

    public abstract class CoreJavadocOptions

Provides the core Javadoc Options. That is, provides the options which are not doclet specific.

Authors:
  Tom Eyckmans

Constructor Summary
`CoreJavadocOptions()`
`protected CoreJavadocOptions(JavadocOptionFile optionFile)`

Method Summary
`JavadocOptionFileOption` | `addBooleanOption(String option)`
`JavadocOptionFileOption` | `addBooleanOption(String option, boolean value)`
`JavadocOptionFileOption` | `addEnumOption(String option)`
`JavadocOptionFileOption` | `addEnumOption(String option, Object value)`
`JavadocOptionFileOption` | `addFileOption(String option)`
`JavadocOptionFileOption` | `addFileOption(String option, File value)`
`JavadocOptionFileOption` | `addMultilineStringsOption(String option)`
`JavadocOptionFileOption` | `addOption(JavadocOptionFileOption option)`
`JavadocOptionFileOption` | `addPathOption(String option)`
`JavadocOptionFileOption` | `addPathOption(String option, String joinBy)`
`JavadocOptionFileOption` | `addStringOption(String option)`
`JavadocOptionFileOption` | `addStringOption(String option, String value)`
`JavadocOptionFileOption` | `addStringsOption(String option)`
`JavadocOptionFileOption` | `addStringsOption(String option, String joinBy)`
`MinimalJavadocOptions` | `bootClasspath(File... bootClasspath)`
`MinimalJavadocOptions` | `breakIterator(boolean breakIterator)`
`MinimalJavadocOptions` | `breakIterator()`
`MinimalJavadocOptions` | `classpath(List 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` | `getBootClasspath()`
`List` | `getClasspath()`
`String` | `getDoclet()`
`List` | `getDocletpath()`
`String` | `getEncoding()`
`List` | `getExtDirs()`
`List` | `getJFlags()`
`String` | `getLocale()`
`JavadocMemberLevel` | `getMemberLevel()`
`List` | `getOptionFiles()`
`JavadocOutputLevel` | `getOutputLevel()`
`String` | `getOverview()`
`String` | `getSource()`
`List` | `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 bootClasspath)`
`void` | `setBreakIterator(boolean breakIterator)`
`void` | `setClasspath(List classpath)`
`void` | `setDoclet(String doclet)`
`void` | `setDocletpath(List docletpath)`
`void` | `setEncoding(String encoding)`
`void` | `setExtDirs(List extDirs)`
`void` | `setJFlags(List jFlags)`
`void` | `setLocale(String locale)`
`void` | `setMemberLevel(JavadocMemberLevel memberLevel)`
`void` | `setOptionFiles(List optionFiles)`
`void` | `setOutputLevel(JavadocOutputLevel outputLevel)`
`void` | `setOverview(String overview)`
`void` | `setSource(String source)`
`void` | `setSourceNames(List 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)`

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

Constructor Detail

### CoreJavadocOptions

    public CoreJavadocOptions()

### CoreJavadocOptions

    protected CoreJavadocOptions(JavadocOptionFile optionFile)

Method Detail

### addBooleanOption

    public JavadocOptionFileOption addBooleanOption(String option)

### addBooleanOption

    public JavadocOptionFileOption addBooleanOption(String option, boolean value)

### addEnumOption

    public JavadocOptionFileOption addEnumOption(String option)

### addEnumOption

    public JavadocOptionFileOption addEnumOption(String option, Object value)

### addFileOption

    public JavadocOptionFileOption addFileOption(String option)

### addFileOption

    public JavadocOptionFileOption addFileOption(String option, File value)

### addMultilineStringsOption

    public JavadocOptionFileOption addMultilineStringsOption(String option)

### addOption

    public JavadocOptionFileOption addOption(JavadocOptionFileOption option)

### addPathOption

    public JavadocOptionFileOption addPathOption(String option)

### addPathOption

    public JavadocOptionFileOption addPathOption(String option, String joinBy)

### addStringOption

    public JavadocOptionFileOption addStringOption(String option)

### addStringOption

    public JavadocOptionFileOption addStringOption(String option, String value)

### addStringsOption

    public JavadocOptionFileOption addStringsOption(String option)

### addStringsOption

    public JavadocOptionFileOption addStringsOption(String option, String joinBy)

### bootClasspath

    public MinimalJavadocOptions bootClasspath(File... bootClasspath)

### breakIterator

    public MinimalJavadocOptions breakIterator(boolean breakIterator)

### breakIterator

    public MinimalJavadocOptions breakIterator()

### classpath

    public MinimalJavadocOptions classpath(List classpath)

### classpath

    public MinimalJavadocOptions classpath(File... classpath)

### contributeCommandLineOptions

    public void contributeCommandLineOptions(ExecSpec execHandleBuilder)

### doclet

    public MinimalJavadocOptions doclet(String doclet)

### docletpath

    public MinimalJavadocOptions docletpath(File... docletpath)

### encoding

    public MinimalJavadocOptions encoding(String encoding)

### extDirs

    public MinimalJavadocOptions extDirs(File... extDirs)

### getBootClasspath

    public List getBootClasspath()

### getClasspath

    public List getClasspath()

### getDoclet

    public String getDoclet()

### getDocletpath

    public List getDocletpath()

### getEncoding

    public String getEncoding()

### getExtDirs

    public List getExtDirs()

### getJFlags

    public List getJFlags()

### getLocale

    public String getLocale()

### getMemberLevel

    public JavadocMemberLevel getMemberLevel()

### getOptionFiles

    public List getOptionFiles()

### getOutputLevel

    public JavadocOutputLevel getOutputLevel()

### getOverview

    public String getOverview()

### getSource

    public String getSource()

### getSourceNames

    public List getSourceNames()

### isBreakIterator

    public boolean isBreakIterator()

### isVerbose

    public boolean isVerbose()

### jFlags

    public MinimalJavadocOptions jFlags(String... jFlags)

### locale

    public MinimalJavadocOptions locale(String locale)

### optionFiles

    public MinimalJavadocOptions optionFiles(File... argumentFiles)

### overview

    public MinimalJavadocOptions overview(String overview)

  Fluent setter for the overview option.
  Parameters:
    `overview` - The new overview.
  Returns:
    The `MinimalJavadocOptions` object.

### quiet

    public MinimalJavadocOptions quiet()

### setBootClasspath

    public void setBootClasspath(List bootClasspath)

### setBreakIterator

    public void setBreakIterator(boolean breakIterator)

### setClasspath

    public void setClasspath(List classpath)

### setDoclet

    public void setDoclet(String doclet)

### setDocletpath

    public void setDocletpath(List docletpath)

### setEncoding

    public void setEncoding(String encoding)

### setExtDirs

    public void setExtDirs(List extDirs)

### setJFlags

    public void setJFlags(List jFlags)

### setLocale

    public void setLocale(String locale)

### setMemberLevel

    public void setMemberLevel(JavadocMemberLevel memberLevel)

### setOptionFiles

    public void setOptionFiles(List optionFiles)

### setOutputLevel

    public void setOutputLevel(JavadocOutputLevel outputLevel)

### setOverview

    public void setOverview(String overview)

### setSource

    public void setSource(String source)

### setSourceNames

    public void setSourceNames(List sourceNames)

### showAll

    public MinimalJavadocOptions showAll()

### showFromPackage

    public MinimalJavadocOptions showFromPackage()

### showFromPrivate

    public MinimalJavadocOptions showFromPrivate()

### showFromProtected

    public MinimalJavadocOptions showFromProtected()

### showFromPublic

    public MinimalJavadocOptions showFromPublic()

### source

    public MinimalJavadocOptions source(String source)

### sourceNames

    public MinimalJavadocOptions sourceNames(String... sourceNames)

### verbose

    public MinimalJavadocOptions verbose()

### write

    public final void write(File outputFile)

Gradle API 1.1-rc-1