Interface MinimalJavadocOptions

All Known Implementing Classes:

CoreJavadocOptions, StandardJavadocDocletOptions

public interface MinimalJavadocOptions

Provides the core Javadoc options.

Since:

0.7

Method Summary

Modifier and Type	Method	Description
MinimalJavadocOptions	bootClasspath(File... bootClasspath)	Boot classpath.
MinimalJavadocOptions	breakIterator()	Break iterator.
MinimalJavadocOptions	breakIterator(boolean breakIterator)	Break iterator.
MinimalJavadocOptions	classpath(File... classpath)	Classpath.
MinimalJavadocOptions	classpath(List<File> classpath)	Classpath.
void	contributeCommandLineOptions(ExecSpec execHandleBuilder)	Contribute command line options.
MinimalJavadocOptions	destinationDirectory(File directory)	Destination directory.
MinimalJavadocOptions	doclet(String docletClass)	Doclet.
MinimalJavadocOptions	docletpath(File... docletpath)	Docletpath.
MinimalJavadocOptions	encoding(String encoding)	Encoding.
MinimalJavadocOptions	extDirs(File... extDirs)	Ext dirs.
List<File>	getBootClasspath()	Returns the boot classpath.
List<File>	getClasspath()	Returns the classpath.
File	getDestinationDirectory()	Returns the destination directory.
@Nullable String	getDoclet()	Returns the doclet.
List<File>	getDocletpath()	Returns the docletpath.
@Nullable String	getEncoding()	Returns the encoding.
@Nullable List<File>	getExtDirs()	Returns the ext dirs.
@Nullable String	getHeader()	Returns the header.
@Nullable List<String>	getJFlags()	Returns the j flags.
@Nullable String	getLocale()	Returns the locale.
@Nullable JavadocMemberLevel	getMemberLevel()	Returns the member level.
List<File>	getModulePath()	The --module-path.
@Nullable List<File>	getOptionFiles()	Returns the option files.
JavadocOutputLevel	getOutputLevel()	Returns the output level.
@Nullable String	getOverview()	Returns the overview.
@Nullable String	getSource()	Returns the source.
@Nullable List<String>	getSourceNames()	Returns the source names.
@Nullable String	getWindowTitle()	Returns the window title.
StandardJavadocDocletOptions	header(String header)	Header.
boolean	isBreakIterator()	Returns whether break iterator is set.
boolean	isVerbose()	Returns whether verbose is set.
MinimalJavadocOptions	jFlags(String... jFlags)	J flags.
MinimalJavadocOptions	locale(String locale)	Locale.
MinimalJavadocOptions	modulePath(List<File> classpath)	The --module-path.
MinimalJavadocOptions	optionFiles(File... argumentFiles)	Option files.
MinimalJavadocOptions	overview(String overview)	Overview.
MinimalJavadocOptions	quiet()	Quiet.
void	setBootClasspath(List<File> bootClasspath)	Sets the boot classpath.
void	setBreakIterator(boolean breakIterator)	Sets the break iterator.
void	setClasspath(List<File> classpath)	Sets the classpath.
void	setDestinationDirectory(@Nullable File directory)	Sets the destination directory.
void	setDoclet(@Nullable String docletClass)	Sets the doclet.
void	setDocletpath(List<File> docletpath)	Sets the docletpath.
void	setEncoding(@Nullable String encoding)	Sets the encoding.
void	setExtDirs(@Nullable List<File> extDirs)	Sets the ext dirs.
void	setHeader(@Nullable String header)	Sets the header.
void	setJFlags(@Nullable List<String> jFlags)	Sets the j flags.
void	setLocale(@Nullable String locale)	Sets the locale.
void	setMemberLevel(@Nullable JavadocMemberLevel memberLevel)	Sets the member level.
void	setModulePath(List<File> modulePath)	The --module-path.
void	setOptionFiles(@Nullable List<File> optionFiles)	Sets the option files.
void	setOutputLevel(JavadocOutputLevel outputLevel)	Sets the output level.
void	setOverview(@Nullable String overview)	Sets the overview.
void	setSource(@Nullable String source)	Sets the source.
void	setSourceNames(@Nullable List<String> sourceNames)	Sets the source names.
void	setWindowTitle(@Nullable String windowTitle)	Sets the window title.
MinimalJavadocOptions	showAll()	Show all.
MinimalJavadocOptions	showFromPackage()	Show from package.
MinimalJavadocOptions	showFromPrivate()	Show from private.
MinimalJavadocOptions	showFromProtected()	Show from protected.
MinimalJavadocOptions	showFromPublic()	Show from public.
MinimalJavadocOptions	source(String source)	Source.
MinimalJavadocOptions	sourceNames(String... sourceNames)	Source names.
MinimalJavadocOptions	verbose()	Verbose.
StandardJavadocDocletOptions	windowTitle(String windowTitle)	Window title.
void	write(File outputFile)	Write.

Method Details

getOverview

@Optional
@Input
@Nullable String getOverview()

Returns the overview.

Since:

0.7

setOverview

void setOverview(@Nullable String overview)

Sets the overview.

Since:

0.7

overview

MinimalJavadocOptions overview(String overview)

Overview.

Since:

0.7

getMemberLevel

@Optional
@Input
@Nullable JavadocMemberLevel getMemberLevel()

Returns the member level.

Since:

0.7

setMemberLevel

void setMemberLevel(@Nullable JavadocMemberLevel memberLevel)

Sets the member level.

Since:

0.7

showFromPublic

MinimalJavadocOptions showFromPublic()

Show from public.

Since:

0.7

showFromProtected

MinimalJavadocOptions showFromProtected()

Show from protected.

Since:

0.7

showFromPackage

MinimalJavadocOptions showFromPackage()

Show from package.

Since:

0.7

showFromPrivate

MinimalJavadocOptions showFromPrivate()

Show from private.

Since:

0.7

showAll

MinimalJavadocOptions showAll()

Show all.

Since:

0.7

getDoclet

@Optional
@Input
@Nullable String getDoclet()

Returns the doclet.

Since:

0.7

setDoclet

void setDoclet(@Nullable String docletClass)

Sets the doclet.

Since:

0.7

doclet

MinimalJavadocOptions doclet(String docletClass)

Doclet.

Since:

0.7

getDocletpath

@Classpath
List<File> getDocletpath()

Returns the docletpath.

Since:

0.9

setDocletpath

void setDocletpath(List<File> docletpath)

Sets the docletpath.

Since:

0.9

docletpath

MinimalJavadocOptions docletpath(File... docletpath)

Docletpath.

Since:

0.9

getSource

@Optional
@Input
@Nullable String getSource()

Returns the source.

Since:

0.7

setSource

void setSource(@Nullable String source)

Sets the source.

Since:

0.7

source

MinimalJavadocOptions source(String source)

Source.

Since:

0.7

getClasspath

@Internal
List<File> getClasspath()

Returns the classpath.

Since:

0.7

setClasspath

void setClasspath(List<File> classpath)

Sets the classpath.

Since:

0.7

getModulePath

@Internal
List<File> getModulePath()

The --module-path.

Since:

6.4

setModulePath

void setModulePath(List<File> modulePath)

The --module-path.

Since:

6.4

modulePath

MinimalJavadocOptions modulePath(List<File> classpath)

The --module-path.

Since:

6.4

classpath

MinimalJavadocOptions classpath(List<File> classpath)

Classpath.

Since:

0.7

classpath

MinimalJavadocOptions classpath(File... classpath)

Classpath.

Since:

0.7

getBootClasspath

@Classpath
List<File> getBootClasspath()

Returns the boot classpath.

Since:

0.7

setBootClasspath

void setBootClasspath(List<File> bootClasspath)

Sets the boot classpath.

Since:

0.7

bootClasspath

MinimalJavadocOptions bootClasspath(File... bootClasspath)

Boot classpath.

Since:

0.7

getExtDirs

@Optional
@IgnoreEmptyDirectories
@PathSensitive(RELATIVE)
@InputFiles
@Nullable List<File> getExtDirs()

Returns the ext dirs.

Since:

0.7

setExtDirs

void setExtDirs(@Nullable List<File> extDirs)

Sets the ext dirs.

Since:

0.7

extDirs

MinimalJavadocOptions extDirs(File... extDirs)

Ext dirs.

Since:

0.7

getOutputLevel

@Console
JavadocOutputLevel getOutputLevel()

Returns the output level.

Since:

0.7

setOutputLevel

void setOutputLevel(JavadocOutputLevel outputLevel)

Sets the output level.

Since:

0.7

verbose

MinimalJavadocOptions verbose()

Verbose.

Since:

0.7

isVerbose

@Internal
boolean isVerbose()

Returns whether verbose is set.

Since:

0.7

quiet

MinimalJavadocOptions quiet()

Quiet.

Since:

0.7

isBreakIterator

@Input
boolean isBreakIterator()

Returns whether break iterator is set.

Since:

0.7

setBreakIterator

void setBreakIterator(boolean breakIterator)

Sets the break iterator.

Since:

0.7

breakIterator

MinimalJavadocOptions breakIterator(boolean breakIterator)

Break iterator.

Since:

0.7

breakIterator

MinimalJavadocOptions breakIterator()

Break iterator.

Since:

0.7

getLocale

@Optional
@Input
@Nullable String getLocale()

Returns the locale.

Since:

0.7

setLocale

void setLocale(@Nullable String locale)

Sets the locale.

Since:

0.7

locale

MinimalJavadocOptions locale(String locale)

Locale.

Since:

0.7

getEncoding

@Optional
@Input
@Nullable String getEncoding()

Returns the encoding.

Since:

0.7

setEncoding

void setEncoding(@Nullable String encoding)

Sets the encoding.

Since:

0.7

encoding

MinimalJavadocOptions encoding(String encoding)

Encoding.

Since:

0.7

getJFlags

@Optional
@Input
@Nullable List<String> getJFlags()

Returns the j flags.

Since:

0.7

setJFlags

void setJFlags(@Nullable List<String> jFlags)

Sets the j flags.

Since:

0.7

jFlags

MinimalJavadocOptions jFlags(String... jFlags)

J flags.

Since:

0.7

getOptionFiles

@Optional
@PathSensitive(NONE)
@InputFiles
@Nullable List<File> getOptionFiles()

Returns the option files.

Since:

0.7

setOptionFiles

void setOptionFiles(@Nullable List<File> optionFiles)

Sets the option files.

Since:

0.7

optionFiles

MinimalJavadocOptions optionFiles(File... argumentFiles)

Option files.

Since:

0.7

getDestinationDirectory

@Internal
File getDestinationDirectory()

Returns the destination directory.

Since:

0.7

setDestinationDirectory

void setDestinationDirectory(@Nullable File directory)

Sets the destination directory.

Since:

0.7

destinationDirectory

MinimalJavadocOptions destinationDirectory(File directory)

Destination directory.

Since:

0.7

getWindowTitle

@Optional
@Input
@Nullable String getWindowTitle()

Returns the window title.

Since:

0.7

setWindowTitle

void setWindowTitle(@Nullable String windowTitle)

Sets the window title.

Since:

0.7

windowTitle

StandardJavadocDocletOptions windowTitle(String windowTitle)

Window title.

Since:

0.7

getHeader

@Optional
@Input
@Nullable String getHeader()

Returns the header.

Since:

0.9

setHeader

void setHeader(@Nullable String header)

Sets the header.

Since:

0.9

header

StandardJavadocDocletOptions header(String header)

Header.

Since:

0.9

write

void write(File outputFile)
    throws IOException

Write.

Throws:

IOException

Since:

0.7

getSourceNames

@Internal
@Nullable List<String> getSourceNames()

Returns the source names.

Since:

0.7

setSourceNames

void setSourceNames(@Nullable List<String> sourceNames)

Sets the source names.

Since:

0.7

sourceNames

MinimalJavadocOptions sourceNames(String... sourceNames)

Source names.

Since:

0.7

contributeCommandLineOptions

void contributeCommandLineOptions(ExecSpec execHandleBuilder)

Contribute command line options.

Since:

0.9