OpenJDK 27 · jdk.javadoc.internal.doclets.toolkit.Messages

Modifier and Type	Field and Description
private final BaseConfiguration	configuration
private boolean	containsDiagnosticMarkers
private final Reporter	reporter
private final Resources	resources

Access	Constructor and Description
public	Messages(BaseConfiguration the doclet's configuration, used to access the doclet's reporter, and additional methods and state used to filter out messages, if any, which should be suppressed. configuration, Resources resources for console messages and exceptions resources) Creates a `Messages` object to provide standardized access to the doclet's diagnostic reporting mechanisms.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if the generated documentation contains one or more diagnostic markers for invalid input containsDiagnosticMarkers() Returns true if the generated documentation contains one or more diagnostic markers for invalid input.
public void	error(String the name of a resource containing the message to be printed key, Object... optional arguments to be replaced in the message args) Reports an error message to the doclet's reporter.
public void	error(DocTreePath a path identifying the position to be included with the message path, String the name of a resource containing the message to be printed key, Object... optional arguments to be replaced in the message args) Reports an error message to the doclet's reporter.
public void	error(DocTreePath a path identifying the position to be included with the message path, int the start of a range of characters to be associated with the message start, int the position to be associated with the message pos, int the end of a range of characters to be associated with the message end, String the name of a resource containing the message to be printed key, Object... optional arguments to be replaced in the message args) Reports an error message to the doclet's reporter.
public void	error(FileObject the file object to be associated with the message fo, int the start of a range of characters to be associated with the message start, int the position to be associated with the message pos, int the end of a range of characters to be associated with the message end, String the name of a resource containing the message to be printed key, Object... optional arguments to be replaced in the message args) Reports an error message to the doclet's reporter.
public void	error(Element an element identifying the position to be included with the message e, String the name of a resource containing the message to be printed key, Object... optional arguments to be replaced in the message args) Reports an error message to the doclet's reporter.
public Resources	Returns: the resources getResources() Returns the resources being used when generating messages.
public void	notice(String the name of a resource containing the message to be printed key, Object... optional arguments to be replaced in the message args) Reports an informational notice to the doclet's reporter.
private void	report(Diagnostic.Kind k, String msg)
private void	report(Diagnostic.Kind k, DocTreePath p, String msg)
private void	report(Diagnostic.Kind k, Element e, String msg)
private void	report(Diagnostic.Kind k, FileObject fo, int start, int pos, int end, String msg)
private void	report(Diagnostic.Kind k, DocTreePath path, int start, int pos, int end, String msg)
public void	setContainsDiagnosticMarkers() Sets the flag for documentation containing a diagnostic marker for invalid input.
public void	warning(String the name of a resource containing the message to be printed key, Object... optional arguments to be replaced in the message args) Reports a warning message to the doclet's reporter.
public void	warning(DocTreePath a path identifying the position to be included with the message path, String the name of a resource containing the message to be printed key, Object... optional arguments to be replaced in the message args) Reports a warning message to the doclet's reporter.
public void	warning(DocTreePath a path identifying the position to be included with the message path, int the start of a range of characters to be associated with the message start, int the position to be associated with the message pos, int the end of a range of characters to be associated with the message end, String the name of a resource containing the message to be printed key, Object... optional arguments to be replaced in the message args) Reports a warning message to the doclet's reporter.
public void	warning(Element an element identifying the position to be included with the message e, String the name of a resource containing the message to be printed key, Object... optional arguments to be replaced in the message args) Reports a warning message to the doclet's reporter.
public void	warning(FileObject the file object to be associated with the message fo, int the start of a range of characters to be associated with the message start, int the position to be associated with the message pos, int the end of a range of characters to be associated with the message end, String the name of a resource containing the message to be printed key, Object... optional arguments to be replaced in the message args) Reports a warning message to the doclet's reporter.

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

configuration	back to summary
private final BaseConfiguration configuration

containsDiagnosticMarkers	back to summary
private boolean containsDiagnosticMarkers

reporter	back to summary
private final Reporter reporter

resources	back to summary
private final Resources resources

Messages	back to summary
public Messages(BaseConfiguration configuration, Resources resources) Creates a `Messages` object to provide standardized access to the doclet's diagnostic reporting mechanisms. Parameters configuration:BaseConfiguration the doclet's configuration, used to access the doclet's reporter, and additional methods and state used to filter out messages, if any, which should be suppressed. resources:Resources resources for console messages and exceptions

Method Detail

containsDiagnosticMarkers	back to summary
public boolean containsDiagnosticMarkers() Returns true if the generated documentation contains one or more diagnostic markers for invalid input. Returns:boolean true if the generated documentation contains one or more diagnostic markers for invalid input

containsDiagnosticMarkers

back to summary

public boolean containsDiagnosticMarkers()

Returns true if the generated documentation contains one or more diagnostic markers for invalid input.

Returns:boolean: true if the generated documentation contains one or more diagnostic markers for invalid input

error	back to summary
public void error(String key, Object... args) Reports an error message to the doclet's reporter. Parameters key:String the name of a resource containing the message to be printed args:Object[] optional arguments to be replaced in the message

error

back to summary

public void error(String key, Object... args)

Reports an error message to the doclet's reporter.

Parameters

key:String: the name of a resource containing the message to be printed
args:Object[]: optional arguments to be replaced in the message

error	back to summary
public void error(DocTreePath path, String key, Object... args) Reports an error message to the doclet's reporter. Parameters path:DocTreePath a path identifying the position to be included with the message key:String the name of a resource containing the message to be printed args:Object[] optional arguments to be replaced in the message

error

back to summary

public void error(DocTreePath path, String key, Object... args)

Reports an error message to the doclet's reporter.

Parameters

path:DocTreePath: a path identifying the position to be included with the message
key:String: the name of a resource containing the message to be printed
args:Object[]: optional arguments to be replaced in the message

error	back to summary
public void error(DocTreePath path, int start, int pos, int end, String key, Object... args) Reports an error message to the doclet's reporter. Parameters path:DocTreePath a path identifying the position to be included with the message start:int the start of a range of characters to be associated with the message pos:int the position to be associated with the message end:int the end of a range of characters to be associated with the message key:String the name of a resource containing the message to be printed args:Object[] optional arguments to be replaced in the message

error

back to summary

public void error(DocTreePath path, int start, int pos, int end, String key, Object... args)

Reports an error message to the doclet's reporter.

Parameters

path:DocTreePath: a path identifying the position to be included with the message
start:int: the start of a range of characters to be associated with the message
pos:int: the position to be associated with the message
end:int: the end of a range of characters to be associated with the message
key:String: the name of a resource containing the message to be printed
args:Object[]: optional arguments to be replaced in the message

error	back to summary
public void error(FileObject fo, int start, int pos, int end, String key, Object... args) Reports an error message to the doclet's reporter. Parameters fo:FileObject the file object to be associated with the message start:int the start of a range of characters to be associated with the message pos:int the position to be associated with the message end:int the end of a range of characters to be associated with the message key:String the name of a resource containing the message to be printed args:Object[] optional arguments to be replaced in the message

error

back to summary

public void error(FileObject fo, int start, int pos, int end, String key, Object... args)

Reports an error message to the doclet's reporter.

Parameters

fo:FileObject: the file object to be associated with the message
start:int: the start of a range of characters to be associated with the message
pos:int: the position to be associated with the message
end:int: the end of a range of characters to be associated with the message
key:String: the name of a resource containing the message to be printed
args:Object[]: optional arguments to be replaced in the message

error	back to summary
public void error(Element e, String key, Object... args) Reports an error message to the doclet's reporter. Parameters e:Element an element identifying the position to be included with the message key:String the name of a resource containing the message to be printed args:Object[] optional arguments to be replaced in the message

error

back to summary

public void error(Element e, String key, Object... args)

Reports an error message to the doclet's reporter.

Parameters

e:Element: an element identifying the position to be included with the message
key:String: the name of a resource containing the message to be printed
args:Object[]: optional arguments to be replaced in the message

getResources	back to summary
public Resources getResources() Returns the resources being used when generating messages. Returns:Resources the resources

getResources

back to summary

public Resources getResources()

Returns the resources being used when generating messages.

Returns:Resources: the resources

notice	back to summary
public void notice(String key, Object... args) Reports an informational notice to the doclet's reporter. The message is written directly to the reporter's diagnostic stream. Parameters key:String the name of a resource containing the message to be printed args:Object[] optional arguments to be replaced in the message

notice

back to summary

public void notice(String key, Object... args)

Reports an informational notice to the doclet's reporter. The message is written directly to the reporter's diagnostic stream.

Parameters

key:String: the name of a resource containing the message to be printed
args:Object[]: optional arguments to be replaced in the message

report	back to summary
private void report(Diagnostic.Kind k, String msg)

report	back to summary
private void report(Diagnostic.Kind k, DocTreePath p, String msg)

report	back to summary
private void report(Diagnostic.Kind k, Element e, String msg)

report	back to summary
private void report(Diagnostic.Kind k, FileObject fo, int start, int pos, int end, String msg)

report	back to summary
private void report(Diagnostic.Kind k, DocTreePath path, int start, int pos, int end, String msg)

setContainsDiagnosticMarkers	back to summary
public void setContainsDiagnosticMarkers() Sets the flag for documentation containing a diagnostic marker for invalid input.

warning	back to summary
public void warning(String key, Object... args) Reports a warning message to the doclet's reporter. Parameters key:String the name of a resource containing the message to be printed args:Object[] optional arguments to be replaced in the message

warning

back to summary

public void warning(String key, Object... args)

Reports a warning message to the doclet's reporter.

Parameters

key:String: the name of a resource containing the message to be printed
args:Object[]: optional arguments to be replaced in the message

warning	back to summary
public void warning(DocTreePath path, String key, Object... args) Reports a warning message to the doclet's reporter. Parameters path:DocTreePath a path identifying the position to be included with the message key:String the name of a resource containing the message to be printed args:Object[] optional arguments to be replaced in the message

warning

back to summary

public void warning(DocTreePath path, String key, Object... args)

Reports a warning message to the doclet's reporter.

Parameters

path:DocTreePath: a path identifying the position to be included with the message
key:String: the name of a resource containing the message to be printed
args:Object[]: optional arguments to be replaced in the message

warning	back to summary
public void warning(DocTreePath path, int start, int pos, int end, String key, Object... args) Reports a warning message to the doclet's reporter. Parameters path:DocTreePath a path identifying the position to be included with the message start:int the start of a range of characters to be associated with the message pos:int the position to be associated with the message end:int the end of a range of characters to be associated with the message key:String the name of a resource containing the message to be printed args:Object[] optional arguments to be replaced in the message

warning

back to summary

public void warning(DocTreePath path, int start, int pos, int end, String key, Object... args)

Reports a warning message to the doclet's reporter.

Parameters

path:DocTreePath: a path identifying the position to be included with the message
start:int: the start of a range of characters to be associated with the message
pos:int: the position to be associated with the message
end:int: the end of a range of characters to be associated with the message
key:String: the name of a resource containing the message to be printed
args:Object[]: optional arguments to be replaced in the message

warning	back to summary
public void warning(Element e, String key, Object... args) Reports a warning message to the doclet's reporter. Parameters e:Element an element identifying the position to be included with the message key:String the name of a resource containing the message to be printed args:Object[] optional arguments to be replaced in the message

warning

back to summary

public void warning(Element e, String key, Object... args)

Reports a warning message to the doclet's reporter.

Parameters

e:Element: an element identifying the position to be included with the message
key:String: the name of a resource containing the message to be printed
args:Object[]: optional arguments to be replaced in the message

warning	back to summary
public void warning(FileObject fo, int start, int pos, int end, String key, Object... args) Reports a warning message to the doclet's reporter. Parameters fo:FileObject the file object to be associated with the message start:int the start of a range of characters to be associated with the message pos:int the position to be associated with the message end:int the end of a range of characters to be associated with the message key:String the name of a resource containing the message to be printed args:Object[] optional arguments to be replaced in the message

warning

back to summary

public void warning(FileObject fo, int start, int pos, int end, String key, Object... args)

Reports a warning message to the doclet's reporter.

Parameters

fo:FileObject: the file object to be associated with the message
start:int: the start of a range of characters to be associated with the message
pos:int: the position to be associated with the message
end:int: the end of a range of characters to be associated with the message
key:String: the name of a resource containing the message to be printed
args:Object[]: optional arguments to be replaced in the message

public Class Messages

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail