Package net.sf.jasperreports.engine.type

Enum IncrementTypeEnum

java.lang.Object

java.lang.Enum<IncrementTypeEnum>

net.sf.jasperreports.engine.type.IncrementTypeEnum

All Implemented Interfaces:

Serializable, Comparable<IncrementTypeEnum>, NamedEnum

public enum IncrementTypeEnum
extends Enum<IncrementTypeEnum>
implements NamedEnum

Author:

Sanda Zaharia (shertage@users.sourceforge.net)

Enum Constant Summary

Enum Constants

Enum Constant	Description
COLUMN	The variable is incremented with each new column.
GROUP	The variable is incremented every time the group specified by the JRVariable.getIncrementGroup() method breaks.
NONE	The variable is incremented with every record during the iteration through the data source.
PAGE	The variable is incremented with each new page.
REPORT	The variable never gets incremented during the report-filling process.

Method Summary

Modifier and Type	Method	Description
static IncrementTypeEnum	getByName(String name)
IncrementTypeEnum	getDefault()
String	getName()
static IncrementTypeEnum	getValueOrDefault(IncrementTypeEnum value)
static IncrementTypeEnum	valueOf(String name)	Returns the enum constant of this type with the specified name.
static IncrementTypeEnum[]	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

REPORT

public static final IncrementTypeEnum REPORT

The variable never gets incremented during the report-filling process.

PAGE

public static final IncrementTypeEnum PAGE

The variable is incremented with each new page.

COLUMN

public static final IncrementTypeEnum COLUMN

The variable is incremented with each new column.

GROUP

public static final IncrementTypeEnum GROUP

The variable is incremented every time the group specified by the JRVariable.getIncrementGroup() method breaks.

NONE

public static final IncrementTypeEnum NONE

The variable is incremented with every record during the iteration through the data source.

Method Detail

values

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

Returns:

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

valueOf

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

getName

public String getName()

Specified by:

getName in interface NamedEnum

getByName

public static IncrementTypeEnum getByName(String name)

getValueOrDefault

public static IncrementTypeEnum getValueOrDefault(IncrementTypeEnum value)

getDefault

public IncrementTypeEnum getDefault()

Specified by:

getDefault in interface NamedEnum