org.apache.maven.plugins.checkstyle

Class IconTool

java.lang.Object

org.apache.maven.plugins.checkstyle.IconTool

public class IconTool
extends java.lang.Object

A little tool to deal with info/warning/error icons in Checkstyle reports, with eventual text.

Since:

2.13

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.ResourceBundle	bundle
static java.lang.String	ERROR
static java.lang.String	INFO
static int	NO_TEXT
private org.apache.maven.doxia.sink.Sink	sink
static int	TEXT_ABBREV
static int	TEXT_SIMPLE
static int	TEXT_TITLE
static java.lang.String	WARNING

Constructor Summary

Constructors

Constructor and Description
IconTool(org.apache.maven.doxia.sink.Sink sink, java.util.ResourceBundle bundle)

Method Summary

Modifier and Type	Method and Description
void	iconError() 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(java.lang.String level) Render a simple icon of given level.
void	iconSeverity(java.lang.String level, int textType) Render an icon of given level with associated text.
void	iconWarning() Render a warning icon.
void	iconWarning(int textType) Render a warning icon with associated text.
private java.lang.String	suffix(int textType)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INFO

public static final java.lang.String INFO

See Also:

Constant Field Values

WARNING

public static final java.lang.String WARNING

See Also:

Constant Field Values

ERROR

public static final java.lang.String ERROR

See Also:

Constant Field Values

NO_TEXT

public static final int NO_TEXT

See Also:

Constant Field Values

TEXT_SIMPLE

public static final int TEXT_SIMPLE

See Also:

Constant Field Values

TEXT_TITLE

public static final int TEXT_TITLE

See Also:

Constant Field Values

TEXT_ABBREV

public static final int TEXT_ABBREV

See Also:

Constant Field Values

sink

private final org.apache.maven.doxia.sink.Sink sink

bundle

private final java.util.ResourceBundle bundle

Constructor Detail

IconTool

public IconTool(org.apache.maven.doxia.sink.Sink sink,
                java.util.ResourceBundle bundle)

Method Detail

iconSeverity

public void iconSeverity(java.lang.String level)

Render a simple icon of given level.

Parameters:

level - one of INFO, WARNING or ERROR constants

iconSeverity

public void iconSeverity(java.lang.String level,
                         int textType)

Render an icon of given level with associated text.

Parameters:

level - one of INFO, WARNING or ERROR constants

textType - one of NO_TEXT, TEXT_SIMPLE, TEXT_TITLE or TEXT_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 of NO_TEXT, TEXT_SIMPLE, TEXT_TITLE or TEXT_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 of NO_TEXT, TEXT_SIMPLE, TEXT_TITLE or TEXT_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 of NO_TEXT, TEXT_SIMPLE, TEXT_TITLE or TEXT_ABBREV constants

suffix

private java.lang.String suffix(int textType)