net.sf.reportengine.util

Enum UserRequestedBoolean

java.lang.Object

java.lang.Enum<UserRequestedBoolean>

net.sf.reportengine.util.UserRequestedBoolean

All Implemented Interfaces:

Serializable, Comparable<UserRequestedBoolean>

public enum UserRequestedBoolean
extends Enum<UserRequestedBoolean>

This is a utility enumeration for default boolean values which might interfere with the user's choice. Example: A flat report doesn't show by default the totals (showTotals = FALSE_NOT_REQUESTED_BY_USER) The user adds a dataColumn (with a groupCalculator) -> the report builder decides it can show totals (showTotals = TRUE_NOT_REQUESTED_BY_USER) The user wants to hide the totals (showTotals = TRUE_REQUESTED_BY_USER) The user adds another dataColumn with a groupCalculator -> the report builder is blocked to the previously set value

Author:

dragos balan

Enum Constant Summary

Enum Constants

Enum Constant and Description
FALSE_NOT_REQUESTED_BY_USER
FALSE_REQUESTED_BY_USER
TRUE_NOT_REQUESTED_BY_USER
TRUE_REQUESTED_BY_USER

Method Summary

Modifier and Type	Method and Description
boolean	getValue()
boolean	isFalse()
boolean	isRequestedByUser()
boolean	isTrue()
static UserRequestedBoolean	valueOf(String name) Returns the enum constant of this type with the specified name.
static UserRequestedBoolean[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TRUE_NOT_REQUESTED_BY_USER

public static final UserRequestedBoolean TRUE_NOT_REQUESTED_BY_USER

FALSE_NOT_REQUESTED_BY_USER

public static final UserRequestedBoolean FALSE_NOT_REQUESTED_BY_USER

TRUE_REQUESTED_BY_USER

public static final UserRequestedBoolean TRUE_REQUESTED_BY_USER

FALSE_REQUESTED_BY_USER

public static final UserRequestedBoolean FALSE_REQUESTED_BY_USER

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public boolean getValue()

isRequestedByUser

public boolean isRequestedByUser()

isTrue

public boolean isTrue()

isFalse

public boolean isFalse()