com.puppycrawl.tools.checkstyle

Class CheckStyleTask.Formatter

java.lang.Object

com.puppycrawl.tools.checkstyle.CheckStyleTask.Formatter

Enclosing class:

CheckStyleTask

public static class CheckStyleTask.Formatter
extends Object

Details about a formatter to be used.

Author:

Oliver Burn

Constructor Summary

Constructors

Constructor and Description
CheckStyleTask.Formatter()

Method Summary

Methods

Modifier and Type	Method and Description
AuditListener	createListener(org.apache.tools.ant.Task task) Creates a listener for the formatter.
void	setTofile(File to) Set the file to output to.
void	setType(CheckStyleTask.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.

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckStyleTask.Formatter

public CheckStyleTask.Formatter()

Method Detail

setType

public void setType(CheckStyleTask.FormatterType type)

Set the type of the formatter.

Parameters:

type - the type

setTofile

public void setTofile(File to)

Set the file to output to.

Parameters:

to - 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 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