Package net.sf.jasperreports.engine.type

Enum BreakTypeEnum

java.lang.Object

java.lang.Enum<BreakTypeEnum>

net.sf.jasperreports.engine.type.BreakTypeEnum

All Implemented Interfaces:

Serializable, Comparable<BreakTypeEnum>, NamedEnum

public enum BreakTypeEnum
extends Enum<BreakTypeEnum>
implements NamedEnum

Author:

Sanda Zaharia (shertage@users.sourceforge.net)

Enum Constant Summary

Enum Constants

Enum Constant	Description
COLUMN	Constant used for specifying that the break element will break the column.
PAGE	Constant used for specifying that the break element will break the page.

Method Summary

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

PAGE

public static final BreakTypeEnum PAGE

Constant used for specifying that the break element will break the page.

COLUMN

public static final BreakTypeEnum COLUMN

Constant used for specifying that the break element will break the column.

Method Detail

values

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

Returns:

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

valueOf

public static BreakTypeEnum 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 BreakTypeEnum getByName(String name)

getValueOrDefault

public static BreakTypeEnum getValueOrDefault(BreakTypeEnum value)

getDefault

public BreakTypeEnum getDefault()

Specified by:

getDefault in interface NamedEnum