edu.internet2.middleware.grouper.app.reports

Enum ReportConfigFormat

java.lang.Object

java.lang.Enum<ReportConfigFormat>

edu.internet2.middleware.grouper.app.reports.ReportConfigFormat

All Implemented Interfaces:

Serializable, Comparable<ReportConfigFormat>

public enum ReportConfigFormat
extends Enum<ReportConfigFormat>

report format e.g. CSV

Enum Constant Summary

Enum Constants

Enum Constant and Description
CSV format of report in comma separated values
FILE format a file

Method Summary

Modifier and Type	Method and Description
abstract void	formatReport(GrouperReportData grouperReportData, GrouperReportInstance grouperReportInstance) format report data into a file
static ReportConfigFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static ReportConfigFormat	valueOfIgnoreCase(String string, boolean exceptionIfBlank) do a case-insensitive matching
static ReportConfigFormat[]	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

CSV

public static final ReportConfigFormat CSV

format of report in comma separated values

FILE

public static final ReportConfigFormat FILE

format a file

Method Detail

values

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

Returns:

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

valueOf

public static ReportConfigFormat 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

formatReport

public abstract void formatReport(GrouperReportData grouperReportData,
                                  GrouperReportInstance grouperReportInstance)

format report data into a file

Parameters:

grouperReportData -

grouperReportInstance -

valueOfIgnoreCase

public static ReportConfigFormat valueOfIgnoreCase(String string,
                                                   boolean exceptionIfBlank)

do a case-insensitive matching

Parameters:

string -

exceptionIfBlank -

Returns:

the enum or null or exception if not found