Class IconTool
java.lang.Object
org.apache.maven.plugins.checkstyle.IconTool
A little tool to deal with info/warning/error icons in Checkstyle reports, with eventual text.
- Since:
- 2.13
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final ResourceBundle
static final String
static final String
static final int
private final org.apache.maven.doxia.sink.Sink
static final int
static final int
static final int
static final String
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Render an error icon.void
iconError
(int textType) Render an error icon with associated text.void
iconInfo()
Render an info icon.void
iconInfo
(int textType) Render an info icon with associated text.void
iconSeverity
(String level) Render a simple icon of given level.void
iconSeverity
(String level, int textType) Render an icon of given level with associated text.void
Render a warning icon.void
iconWarning
(int textType) Render a warning icon with associated text.private String
suffix
(int textType)
-
Field Details
-
INFO
- See Also:
-
WARNING
- See Also:
-
ERROR
- See Also:
-
NO_TEXT
public static final int NO_TEXT- See Also:
-
TEXT_SIMPLE
public static final int TEXT_SIMPLE- See Also:
-
TEXT_TITLE
public static final int TEXT_TITLE- See Also:
-
TEXT_ABBREV
public static final int TEXT_ABBREV- See Also:
-
sink
private final org.apache.maven.doxia.sink.Sink sink -
bundle
-
-
Constructor Details
-
IconTool
-
-
Method Details
-
iconSeverity
Render a simple icon of given level.- Parameters:
level
- one ofINFO
,WARNING
orERROR
constants
-
iconSeverity
Render an icon of given level with associated text.- Parameters:
level
- one ofINFO
,WARNING
orERROR
constantstextType
- one ofNO_TEXT
,TEXT_SIMPLE
,TEXT_TITLE
orTEXT_ABBREV
constants
-
iconInfo
public void iconInfo()Render an info icon. -
iconInfo
public void iconInfo(int textType) Render an info icon with associated text.- Parameters:
textType
- one ofNO_TEXT
,TEXT_SIMPLE
,TEXT_TITLE
orTEXT_ABBREV
constants
-
iconWarning
public void iconWarning()Render a warning icon. -
iconWarning
public void iconWarning(int textType) Render a warning icon with associated text.- Parameters:
textType
- one ofNO_TEXT
,TEXT_SIMPLE
,TEXT_TITLE
orTEXT_ABBREV
constants
-
iconError
public void iconError()Render an error icon. -
iconError
public void iconError(int textType) Render an error icon with associated text.- Parameters:
textType
- one ofNO_TEXT
,TEXT_SIMPLE
,TEXT_TITLE
orTEXT_ABBREV
constants
-
suffix
-