IconTool (Apache Maven Checkstyle Plugin 2.16 API)

java.lang.Object
- org.apache.maven.plugin.checkstyle.IconTool

```
public class IconTool
extends 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
`static String`	`ERROR`
`static String`	`INFO`
`static int`	`NO_TEXT`
`static int`	`TEXT_ABBREV`
`static int`	`TEXT_SIMPLE`
`static int`	`TEXT_TITLE`
`static String`	`WARNING`

Constructor Summary

Constructors
Constructor and Description

IconTool(Sink sink, ResourceBundle bundle)

Constructors
Constructor and Description
`IconTool(Sink sink, ResourceBundle bundle)`

Method Summary

Methods
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(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`	`iconWarning()` Render a warning icon.
`void`	`iconWarning(int textType)` Render a warning icon with associated text.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INFO
```
public static final String INFO
```
    See Also:
    Constant Field Values
  - WARNING
```
public static final String WARNING
```
    See Also:
    Constant Field Values
  - ERROR
```
public static final 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
- Constructor Detail
  - IconTool
```
public IconTool(Sink sink,
        ResourceBundle bundle)
```
- Method Detail
  - iconSeverity
```
public void iconSeverity(String level)
```
    Render a simple icon of given level.
    
    Parameters:
    level - one of INFO, WARNING or ERROR constants
  - iconSeverity
```
public void iconSeverity(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

Class IconTool

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INFO

WARNING

ERROR

NO_TEXT

TEXT_SIMPLE

TEXT_TITLE

TEXT_ABBREV

Constructor Detail

IconTool

Method Detail

iconSeverity

iconSeverity

iconInfo

iconInfo

iconWarning

iconWarning

iconError

iconError