Package com.puppycrawl.tools.checkstyle

Enum Main.OutputFormat

java.lang.Object

java.lang.Enum<Main.OutputFormat>

com.puppycrawl.tools.checkstyle.Main.OutputFormat

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Main.OutputFormat>

Enclosing class:

Main

static enum Main.OutputFormat
extends java.lang.Enum<Main.OutputFormat>

Enumeration over the possible output formats.

Enum Constant Summary

Enum Constants

Enum Constant	Description
PLAIN	Plain output format.
SARIF	SARIF output format.
XML	XML output format.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	OutputFormat()

Method Summary

Modifier and Type	Method	Description
AuditListener	createListener(java.io.OutputStream out, AbstractAutomaticBean.OutputStreamOptions options)	Returns a new AuditListener for this OutputFormat.
java.lang.String	toString()	Returns the name in lowercase.
static Main.OutputFormat	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static Main.OutputFormat[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

XML

public static final Main.OutputFormat XML

XML output format.

SARIF

public static final Main.OutputFormat SARIF

SARIF output format.

PLAIN

public static final Main.OutputFormat PLAIN

Plain output format.

Constructor Detail

OutputFormat

private OutputFormat()

Method Detail

values

public static Main.OutputFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Main.OutputFormat c : Main.OutputFormat.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Main.OutputFormat valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

createListener

public AuditListener createListener(java.io.OutputStream out,
                                    AbstractAutomaticBean.OutputStreamOptions options)
                             throws java.io.IOException

Returns a new AuditListener for this OutputFormat.

Parameters:

out - the output stream

options - the output stream options

Returns:

a new AuditListener for this OutputFormat

Throws:

java.io.IOException - if there is any IO exception during logger initialization

toString

public java.lang.String toString()

Returns the name in lowercase.

Overrides:

toString in class java.lang.Enum<Main.OutputFormat>

Returns:

the enum name in lowercase