Class 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
    • Constructor Detail

      • IconTool

        public IconTool​(org.apache.maven.doxia.sink.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