guru.nidi.ramlproxy.report

Enum ReportFormat

java.lang.Object

java.lang.Enum<ReportFormat>

guru.nidi.ramlproxy.report.ReportFormat

All Implemented Interfaces:

Serializable, Comparable<ReportFormat>

public enum ReportFormat
extends Enum<ReportFormat>

Enum Constant Summary

Enum Constants

Enum Constant and Description
JSON
TEXT

Method Summary

Methods

Modifier and Type	Method and Description
static UsageData	createUsageData(String key, guru.nidi.ramltester.core.Usage usage)
static ViolationData	createViolationData(long id, guru.nidi.ramltester.core.RamlReport report, guru.nidi.ramltester.servlet.ServletRamlRequest request, guru.nidi.ramltester.servlet.ServletRamlResponse response)
abstract String	formatUsage(String key, guru.nidi.ramltester.core.Usage usage)
abstract String	formatViolations(long id, guru.nidi.ramltester.core.RamlReport report, guru.nidi.ramltester.servlet.ServletRamlRequest request, guru.nidi.ramltester.servlet.ServletRamlResponse response)
static ReportFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static ReportFormat[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TEXT

public static final ReportFormat TEXT

JSON

public static final ReportFormat JSON

Method Detail

values

public static ReportFormat[] 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 (ReportFormat c : ReportFormat.values())
    System.out.println(c);

Returns:

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

valueOf

public static ReportFormat valueOf(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:

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

NullPointerException - if the argument is null

formatUsage

public abstract String formatUsage(String key,
                 guru.nidi.ramltester.core.Usage usage)
                            throws IOException

Throws:

IOException

formatViolations

public abstract String formatViolations(long id,
                      guru.nidi.ramltester.core.RamlReport report,
                      guru.nidi.ramltester.servlet.ServletRamlRequest request,
                      guru.nidi.ramltester.servlet.ServletRamlResponse response)
                                 throws IOException

Throws:

IOException

createUsageData

public static UsageData createUsageData(String key,
                        guru.nidi.ramltester.core.Usage usage)

createViolationData

public static ViolationData createViolationData(long id,
                                guru.nidi.ramltester.core.RamlReport report,
                                guru.nidi.ramltester.servlet.ServletRamlRequest request,
                                guru.nidi.ramltester.servlet.ServletRamlResponse response)
                                         throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException