org.jcoderz.phoenix.report
Class ReportFormat

java.lang.Object
  org.jcoderz.phoenix.report.ReportFormat

All Implemented Interfaces:

Serializable, EnumType, StrongType

public final class ReportFormat
extends Object
implements Serializable, EnumType

Enumerated type of a report format. Instances of this class are immutable. The following report formats are defined:

• ReportFormat.SOURCE_DIRECTORY = 'sourceDirectory'
• ReportFormat.JCODERZ = 'jcoderz'
• ReportFormat.CHECKSTYLE = 'checkstyle'
• ReportFormat.JCOVERAGE = 'jcoverage'
• ReportFormat.FINDBUGS = 'findbugs'
• ReportFormat.PMD = 'pmd'
• ReportFormat.CPD = 'cpd'
• ReportFormat.COBERTURA = 'cobertura'
• ReportFormat.EMMA = 'emma'
• ReportFormat.GENERIC = 'generic'

The values of this enum have a internal sequential integer representation starting with '0'.

Author:

generated

See Also:

Serialized Form

Field Summary

static ReportFormat	CHECKSTYLE The ReportFormat checkstyle.
static ReportFormat	COBERTURA The ReportFormat cobertura.
static ReportFormat	CPD The ReportFormat cpd.
static ReportFormat	EMMA The ReportFormat emma.
static ReportFormat	FINDBUGS The ReportFormat findbugs.
static ReportFormat	GENERIC The ReportFormat generic.
static ReportFormat	JCODERZ The ReportFormat jcoderz.
static ReportFormat	JCOVERAGE The ReportFormat jcoverage.
static ReportFormat	PMD The ReportFormat pmd.
static ReportFormat	SOURCE_DIRECTORY The ReportFormat sourceDirectory.
static String	TYPE_NAME The name of this type.
static Map	VALUE_MAP Immutable map using the name string as key holding the ReportFormats as values.
static List	VALUES Immutable list of the ReportFormats.

Method Summary

static ReportFormat	fromInt(int i) Creates a ReportFormat object from its int representation.
static ReportFormat	fromString(String str) Creates a ReportFormat object from its String representation.
int	toInt() Returns the int representation of this report format.
String	toString() Returns the String representation of this report format.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_NAME

public static final String TYPE_NAME

The name of this type.

See Also:

Constant Field Values

SOURCE_DIRECTORY

public static final ReportFormat SOURCE_DIRECTORY

The ReportFormat sourceDirectory.

JCODERZ

public static final ReportFormat JCODERZ

The ReportFormat jcoderz.

CHECKSTYLE

public static final ReportFormat CHECKSTYLE

The ReportFormat checkstyle.

JCOVERAGE

public static final ReportFormat JCOVERAGE

The ReportFormat jcoverage.

FINDBUGS

public static final ReportFormat FINDBUGS

The ReportFormat findbugs.

PMD

public static final ReportFormat PMD

The ReportFormat pmd.

CPD

public static final ReportFormat CPD

The ReportFormat cpd.

COBERTURA

public static final ReportFormat COBERTURA

The ReportFormat cobertura.

EMMA

public static final ReportFormat EMMA

The ReportFormat emma.

GENERIC

public static final ReportFormat GENERIC

The ReportFormat generic.

VALUES

public static final List VALUES

Immutable list of the ReportFormats.

VALUE_MAP

public static final Map VALUE_MAP

Immutable map using the name string as key holding the ReportFormats as values.

Method Detail

fromInt

public static ReportFormat fromInt(int i)
                            throws ArgumentMalformedException

Creates a ReportFormat object from its int representation.

Parameters:

i - the integer representation of the report format.

Returns:

the ReportFormat object represented by this int.

Throws:

ArgumentMalformedException - If the assigned int value isn't listed in the internal report format table.

fromString

public static ReportFormat fromString(String str)
                               throws ArgumentMalformedException

Creates a ReportFormat object from its String representation.

Parameters:

str - the string representation of the report format.

Returns:

the ReportFormat object represented by this str.

Throws:

ArgumentMalformedException - If the given str value isn't listed in the internal report format table.

toInt

public int toInt()

Returns the int representation of this report format.

Specified by:

toInt in interface EnumType

Returns:

the int representation of this report format.

toString

public String toString()

Returns the String representation of this report format.

Overrides:

toString in class Object

Returns:

the String representation of this report format.