org.netbeans.spi.java.hints

Annotation Type Hint

@Target(value={TYPE,METHOD})
 @Retention(value=SOURCE)
public @interface Hint

Description of a hint. When applied to a class, any enclosed method marked with a trigger will be considered to be part of this hint. When applied to a method, only this specific method will be considered to the part of the hint. Currently recognized triggers include TriggerPattern and TriggerTreeKind.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	category Category where the hint belongs.
String	description The hint's long description.
String	displayName The hint's display name.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends CustomizerProvider>	customizerProvider A customizer that allows to customize hint's preferences.
boolean	enabled Should the hint be enabled by default?
Hint.Kind	hintKind Whether the hint should be considered an inspection, i.e.
String	id Manually specify the hint's id.
String	minSourceVersion Minimum source version required to process this hint.
Hint.Options[]	options Specify various options for the hint
Severity	severity Default severity of the hint.
String[]	suppressWarnings Suppress warnings keys that should automatically suppress the hint.

Element Detail

displayName

public abstract String displayName

The hint's display name.

description

public abstract String description

The hint's long description.

category

public abstract String category

Category where the hint belongs.

id

public abstract String id

Manually specify the hint's id. Use only when reorganizing code to keep compatibility with settings from previous version. Id will be generated automatically if not specified.

Default:

""

enabled

public abstract boolean enabled

Should the hint be enabled by default?

Default:

true

severity

public abstract Severity severity

Default severity of the hint. Severity.HINT will typically be shown only on the line with the caret.

Default:

VERIFIER

suppressWarnings

public abstract String[] suppressWarnings

Suppress warnings keys that should automatically suppress the hint.

Default:

{}

customizerProvider

public abstract Class<? extends CustomizerProvider> customizerProvider

A customizer that allows to customize hint's preferences.

Default:

org.netbeans.spi.java.hints.CustomizerProvider.class

hintKind

public abstract Hint.Kind hintKind

Whether the hint should be considered an inspection, i.e. it detects a code smell, or otherwise leads to improving the code, or a Hint.Kind.ACTION, which is simply an offer to do automatically do something for the user.

Default:

INSPECTION

options

public abstract Hint.Options[] options

Specify various options for the hint

Default:

{}

minSourceVersion

public abstract String minSourceVersion

Minimum source version required to process this hint. Annotated hint will be never invoked for files configured for earlier source level. The value should be single integer e.g. "3" for source level 1.3.

Returns:

required source level

Default:

""