com.puppycrawl.tools.checkstyle

Class CheckStyleTask.Formatter

public static class CheckStyleTask.Formatter extends Object

Details about a formatter to be used.

Author: Oliver Burn

Method Summary
AuditListenercreateListener(Task aTask)
Creates a listener for the formatter.
voidsetTofile(File aTo)
Set the file to output to.
voidsetType(CheckStyleTask.FormatterType aType)
Set the type of the formatter.
voidsetUseFile(boolean aUse)
Sets whether or not we write to a file if it is provided.

Method Detail

createListener

public AuditListener createListener(Task aTask)
Creates a listener for the formatter.

Parameters: aTask the task running

Returns: a listener

Throws: IOException if an error occurs

setTofile

public void setTofile(File aTo)
Set the file to output to.

Parameters: aTo the file to output to

setType

public void setType(CheckStyleTask.FormatterType aType)
Set the type of the formatter.

Parameters: aType the type

setUseFile

public void setUseFile(boolean aUse)
Sets whether or not we write to a file if it is provided.

Parameters: aUse whether not not to use provided file.