Class CheckstyleAntTask.Formatter
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.Formatter
-
- Enclosing class:
- CheckstyleAntTask
public static class CheckstyleAntTask.Formatter extends Object
Details about a formatter to be used.
-
-
Field Summary
Fields Modifier and Type Field Description private File
toFile
The file to output to.private CheckstyleAntTask.FormatterType
type
The formatter type.private boolean
useFile
Whether or not to write to the named file.
-
Constructor Summary
Constructors Constructor Description Formatter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private AuditListener
createDefaultLogger(org.apache.tools.ant.Task task)
Creates default logger.AuditListener
createListener(org.apache.tools.ant.Task task)
Creates a listener for the formatter.private AuditListener
createSarifLogger(org.apache.tools.ant.Task task)
Creates Sarif logger.private AuditListener
createXmlLogger(org.apache.tools.ant.Task task)
Creates XML logger.void
setTofile(File destination)
Set the file to output to.void
setType(CheckstyleAntTask.FormatterType type)
Set the type of the formatter.void
setUseFile(boolean use)
Sets whether or not we write to a file if it is provided.
-
-
-
Field Detail
-
type
private CheckstyleAntTask.FormatterType type
The formatter type.
-
useFile
private boolean useFile
Whether or not to write to the named file.
-
-
Constructor Detail
-
Formatter
public Formatter()
-
-
Method Detail
-
setType
public void setType(CheckstyleAntTask.FormatterType type)
Set the type of the formatter.- Parameters:
type
- the type
-
setTofile
public void setTofile(File destination)
Set the file to output to.- Parameters:
destination
- destination the file to output to
-
setUseFile
public void setUseFile(boolean use)
Sets whether or not we write to a file if it is provided.- Parameters:
use
- whether not to use provided file.
-
createListener
public AuditListener createListener(org.apache.tools.ant.Task task) throws IOException
Creates a listener for the formatter.- Parameters:
task
- the task running- Returns:
- a listener
- Throws:
IOException
- if an error occurs
-
createSarifLogger
private AuditListener createSarifLogger(org.apache.tools.ant.Task task) throws IOException
Creates Sarif logger.- Parameters:
task
- the task to possibly log to- Returns:
- an SarifLogger instance
- Throws:
IOException
- if an error occurs
-
createDefaultLogger
private AuditListener createDefaultLogger(org.apache.tools.ant.Task task) throws IOException
Creates default logger.- Parameters:
task
- the task to possibly log to- Returns:
- a DefaultLogger instance
- Throws:
IOException
- if an error occurs
-
createXmlLogger
private AuditListener createXmlLogger(org.apache.tools.ant.Task task) throws IOException
Creates XML logger.- Parameters:
task
- the task to possibly log to- Returns:
- an XMLLogger instance
- Throws:
IOException
- if an error occurs
-
-