54 * then the doclet's behavior is not defined by this interface specification.
55 * <p> To start the doclet, pass {@code -doclet} followed by the fully-qualified
56 * name of the entry point class (i.e. the implementation of this interface) on
57 * the javadoc tool command line.
58 *
59 * @since 9
60 */
61 public interface Doclet {
62
63 /**
64 * Initializes this doclet with the given locale and error reporter.
65 * This locale will be used by the reporter and the doclet components.
66 *
67 * @param locale the locale to be used
68 * @param reporter the reporter to be used
69 */
70 void init(Locale locale, Reporter reporter);
71
72 /**
73 * Returns a name identifying the doclet. A name is a simple identifier
74 * without white spaces, as defined in <cite>The Java™ Language Specification</cite>,
75 * section 6.2 "Names and Identifiers".
76 *
77 * @return name of the Doclet
78 */
79 String getName();
80
81 /**
82 * Returns all the supported options.
83 *
84 * @return a set containing all the supported options, an empty set if none
85 */
86 Set<? extends Option> getSupportedOptions();
87
88 /**
89 * Returns the version of the Java Programming Language supported
90 * by this doclet.
91 *
92 * @return the language version supported by this doclet, usually
93 * the latest version
94 */
|
54 * then the doclet's behavior is not defined by this interface specification.
55 * <p> To start the doclet, pass {@code -doclet} followed by the fully-qualified
56 * name of the entry point class (i.e. the implementation of this interface) on
57 * the javadoc tool command line.
58 *
59 * @since 9
60 */
61 public interface Doclet {
62
63 /**
64 * Initializes this doclet with the given locale and error reporter.
65 * This locale will be used by the reporter and the doclet components.
66 *
67 * @param locale the locale to be used
68 * @param reporter the reporter to be used
69 */
70 void init(Locale locale, Reporter reporter);
71
72 /**
73 * Returns a name identifying the doclet. A name is a simple identifier
74 * without white spaces, as defined in <cite>The Java Language Specification</cite>,
75 * section 6.2 "Names and Identifiers".
76 *
77 * @return name of the Doclet
78 */
79 String getName();
80
81 /**
82 * Returns all the supported options.
83 *
84 * @return a set containing all the supported options, an empty set if none
85 */
86 Set<? extends Option> getSupportedOptions();
87
88 /**
89 * Returns the version of the Java Programming Language supported
90 * by this doclet.
91 *
92 * @return the language version supported by this doclet, usually
93 * the latest version
94 */
|