APIdia Launch Partner
Top Description Inners Fields Constructors Methods
jdk.javadoc.internal.doclint

public Class Messages

extends Object
Class Inheritance
Imports
java.io.PrintWriter, java.text.MessageFormat, java.util.Comparator, .HashMap, .Locale, .Map, .MissingResourceException, .ResourceBundle, .Set, .TreeMap, .TreeSet, javax.tools.Diagnostic, com.sun.source.doctree.DocTree, com.sun.source.tree.Tree, com.sun.tools.javac.api.JavacTrees, com.sun.tools.javac.util.StringUtils, jdk.javadoc.internal.tool.AccessLevel
Message reporting for DocLint. Options are used to filter out messages based on group and access level. Support can be enabled for accumulating statistics of different kinds of messages.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
Messages.Group

Groups used to categorize messages, so that messages in each group can be enabled or disabled via options.

pack-priv static class
Messages.Options

Handler for (sub)options specific to message handling.

pack-priv static class
Messages.Stats

Optionally record statistics of different kinds of message.

Field Summary

Modifier and TypeField and Description
pack-priv ResourceBundle
bundle

pack-priv Env
env

private final Messages.Options
options

private final Messages.Stats
stats

Constructor Summary

AccessConstructor and Description
pack-priv
Messages(Env env)

Method Summary

Modifier and TypeMethod and Description
pack-priv void
error(Messages.Group group, DocTree tree, String code, Object... args)

pack-priv boolean
isEnabled(Messages.Group group, AccessLevel al)

pack-priv String
localize(String code, Object... args)

pack-priv void
note(Messages.Group group, String code, Object... args)

protected void
report(Messages.Group group, Diagnostic.Kind dkind, String code, Object... args)

protected void
report(Messages.Group group, Diagnostic.Kind dkind, DocTree tree, String code, Object... args)

protected void
report(Messages.Group group, Diagnostic.Kind dkind, Tree tree, String code, Object... args)

pack-priv void
reportStats(PrintWriter out)

pack-priv void
setOptions(String opts)

pack-priv void
setStatsEnabled(boolean b)

pack-priv void
warning(Messages.Group group, DocTree tree, String code, Object... args)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

bundleback to summary
pack-priv ResourceBundle bundle
envback to summary
pack-priv Env env
optionsback to summary
private final Messages.Options options
statsback to summary
private final Messages.Stats stats

Constructor Detail

Messagesback to summary
pack-priv Messages(Env env)

Method Detail

errorback to summary
pack-priv void error(Messages.Group group, DocTree tree, String code, Object... args)
isEnabledback to summary
pack-priv boolean isEnabled(Messages.Group group, AccessLevel al)
localizeback to summary
pack-priv String localize(String code, Object... args)
noteback to summary
pack-priv void note(Messages.Group group, String code, Object... args)
reportback to summary
protected void report(Messages.Group group, Diagnostic.Kind dkind, String code, Object... args)
reportback to summary
protected void report(Messages.Group group, Diagnostic.Kind dkind, DocTree tree, String code, Object... args)
reportback to summary
protected void report(Messages.Group group, Diagnostic.Kind dkind, Tree tree, String code, Object... args)
reportStatsback to summary
pack-priv void reportStats(PrintWriter out)
setOptionsback to summary
pack-priv void setOptions(String opts)
setStatsEnabledback to summary
pack-priv void setStatsEnabled(boolean b)
warningback to summary
pack-priv void warning(Messages.Group group, DocTree tree, String code, Object... args)
jdk.javadoc.internal.doclint back to summary

public final Enum Messages.Group

extends Enum<Messages.Group>
Class Inheritance
Groups used to categorize messages, so that messages in each group can be enabled or disabled via options.

Field Summary

Modifier and TypeField and Description
public static final Messages.Group
ACCESSIBILITY

public static final Messages.Group
HTML

public static final Messages.Group
MISSING

public static final Messages.Group
REFERENCE

public static final Messages.Group
SYNTAX

Constructor Summary

AccessConstructor and Description
private
Group()

Method Summary

Modifier and TypeMethod and Description
pack-priv static boolean
accepts(String opt)

pack-priv String
notOptName()

pack-priv String
optName()

public static Messages.Group
valueOf(String name)

public static Messages.Group[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ACCESSIBILITYback to summary
public static final Messages.Group ACCESSIBILITY
HTMLback to summary
public static final Messages.Group HTML
MISSINGback to summary
public static final Messages.Group MISSING
REFERENCEback to summary
public static final Messages.Group REFERENCE
SYNTAXback to summary
public static final Messages.Group SYNTAX

Constructor Detail

Groupback to summary
private Group()

Method Detail

acceptsback to summary
pack-priv static boolean accepts(String opt)
notOptNameback to summary
pack-priv String notOptName()
optNameback to summary
pack-priv String optName()
valueOfback to summary
public static Messages.Group valueOf(String name)
valuesback to summary
public static Messages.Group[] values()
jdk.javadoc.internal.doclint back to summary

pack-priv Class Messages.Options

extends Object
Class Inheritance
Handler for (sub)options specific to message handling.

Field Summary

Modifier and TypeField and Description
private static final String
ALL

private final Map<String, AccessLevel>
map

private final Messages.Stats
stats

Constructor Summary

AccessConstructor and Description
pack-priv
Options(Messages.Stats stats)

Method Summary

Modifier and TypeMethod and Description
pack-priv static boolean
accepts(String opt)

pack-priv boolean
isEnabled(Messages.Group g, AccessLevel access)

Determine if a message group is enabled for a particular access level.

private static boolean
isValidOption(String opt)

pack-priv static boolean
isValidOptions(String opts)

private void
setOption(String arg)

private void
setOption(String opt, AccessLevel al)

pack-priv void
setOptions(String opts)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ALLback to summary
private static final String ALL
mapback to summary
private final Map<String, AccessLevel> map
statsback to summary
private final Messages.Stats stats

Constructor Detail

Optionsback to summary
pack-priv Options(Messages.Stats stats)

Method Detail

acceptsback to summary
pack-priv static boolean accepts(String opt)
isEnabledback to summary
pack-priv boolean isEnabled(Messages.Group g, AccessLevel access)

Determine if a message group is enabled for a particular access level.

isValidOptionback to summary
private static boolean isValidOption(String opt)
isValidOptionsback to summary
pack-priv static boolean isValidOptions(String opts)
setOptionback to summary
private void setOption(String arg) throws IllegalArgumentException
setOptionback to summary
private void setOption(String opt, AccessLevel al)
setOptionsback to summary
pack-priv void setOptions(String opts)
jdk.javadoc.internal.doclint back to summary

pack-priv Class Messages.Stats

extends Object
Class Inheritance
Optionally record statistics of different kinds of message.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
Messages.Stats.Table

A table of (int, String) sorted by decreasing int.

Field Summary

Modifier and TypeField and Description
pack-priv final ResourceBundle
bundle

pack-priv Map<String, Integer>
codeCounts

pack-priv int[]
dkindCounts

pack-priv int[]
groupCounts

public static final String
NO_CODE

public static final String
OPT

Constructor Summary

AccessConstructor and Description
pack-priv
Stats(ResourceBundle bundle)

Method Summary

Modifier and TypeMethod and Description
pack-priv void
record(Messages.Group g, Diagnostic.Kind dkind, String code)

pack-priv void
report(PrintWriter out)

pack-priv void
setEnabled(boolean b)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

bundleback to summary
pack-priv final ResourceBundle bundle
codeCountsback to summary
pack-priv Map<String, Integer> codeCounts
dkindCountsback to summary
pack-priv int[] dkindCounts
groupCountsback to summary
pack-priv int[] groupCounts
NO_CODEback to summary
public static final String NO_CODE
OPTback to summary
public static final String OPT

Constructor Detail

Statsback to summary
pack-priv Stats(ResourceBundle bundle)

Method Detail

recordback to summary
pack-priv void record(Messages.Group g, Diagnostic.Kind dkind, String code)
reportback to summary
pack-priv void report(PrintWriter out)
setEnabledback to summary
pack-priv void setEnabled(boolean b)
jdk.javadoc.internal.doclint back to summary

private Class Messages.Stats.Table

extends Object
Class Inheritance
A table of (int, String) sorted by decreasing int.

Field Summary

Modifier and TypeField and Description
private static final Comparator<Integer>
DECREASING

private final TreeMap<Integer, Set<String>>
map

Constructor Summary

AccessConstructor and Description
private
Table()

Method Summary

Modifier and TypeMethod and Description
pack-priv void
print(PrintWriter out)

pack-priv void
put(String label, int n)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

DECREASINGback to summary
private static final Comparator<Integer> DECREASING
mapback to summary
private final TreeMap<Integer, Set<String>> map

Constructor Detail

Tableback to summary
private Table()

Method Detail

printback to summary
pack-priv void print(PrintWriter out)
putback to summary
pack-priv void put(String label, int n)