APIdia Launch Partner

Top Description Inners Fields Constructors Methods

com.sun.tools.doclint

public abstract Class DocLint

Class Inheritance

extends Object
implements Plugin

java.lang.Object
com.sun.tools.doclint.DocLint

All Implemented Interfaces

com.sun.source.util.Plugin

Known Direct Subclasses

com.sun.tools.doclint.DocLint.NoDocLint

Imports

java.util.ServiceLoader, com.sun.source.util.JavacTask, .Plugin

The base class for the DocLint service used by javac.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	DocLint.NoDocLint

Field Summary

Modifier and Type	Field and Description
private static ServiceLoader.Provider<DocLint>	docLintProvider
public static final String	XCHECK_PACKAGE
public static final String	XMSGS_CUSTOM_PREFIX
public static final String	XMSGS_OPTION

Constructor Summary

Access	Constructor and Description
public	DocLint()

Method Summary

Modifier and Type	Method and Description
public abstract boolean	isValidOption(String opt)
public static synchronized DocLint	newDocLint()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

docLintProvider	back to summary
private static ServiceLoader.Provider<DocLint> docLintProvider

XCHECK_PACKAGE	back to summary
public static final String XCHECK_PACKAGE

XMSGS_CUSTOM_PREFIX	back to summary
public static final String XMSGS_CUSTOM_PREFIX

XMSGS_OPTION	back to summary
public static final String XMSGS_OPTION

Constructor Detail

DocLint	back to summary
public DocLint()

Method Detail

isValidOption	back to summary
public abstract boolean isValidOption(String opt)

newDocLint	back to summary
public static synchronized DocLint newDocLint()

com.sun.tools.doclint back to summary

private Class DocLint.NoDocLint

Class Inheritance

extends DocLint

java.lang.Object
com.sun.tools.doclint.DocLint
com.sun.tools.doclint.DocLint.NoDocLint

Field Summary

Inherited from com.sun.tools.doclint.DocLint:: XCHECK_PACKAGE XMSGS_CUSTOM_PREFIX XMSGS_OPTION

Constructor Summary

Access	Constructor and Description
private	NoDocLint()

Method Summary

Modifier and Type	Method and Description
public String	getName() Implements com.sun.source.util.Plugin.getName. Returns the user-friendly name of this plug-in.
public void	init(JavacTask task, String... args) Implements com.sun.source.util.Plugin.init. Initializes the plug-in for a given compilation task.
public boolean	isValidOption(String s) Implements abstract com.sun.tools.doclint.DocLint.isValidOption.

Inherited from com.sun.tools.doclint.DocLint:: newDocLint

Constructor Detail

NoDocLint	back to summary
private NoDocLint()

Method Detail

getName

back to summary

public String getName()

Implements com.sun.source.util.Plugin.getName.

Doc from com.sun.source.util.Plugin.getName.

Returns the user-friendly name of this plug-in.

Annotations

@Override

init

back to summary

public void init(JavacTask task, String... args)

Implements com.sun.source.util.Plugin.init.

Doc from com.sun.source.util.Plugin.init.

Initializes the plug-in for a given compilation task.

Annotations

@Override

isValidOption

back to summary

public boolean isValidOption(String s)

Implements abstract com.sun.tools.doclint.DocLint.isValidOption.

Annotations

@Override