Package overit.geocall.model.paging

Enum Class PageSize

java.lang.Object

java.lang.Enum<PageSize>

overit.geocall.model.paging.PageSize

All Implemented Interfaces:

Serializable, Comparable<PageSize>, Constable

public enum PageSize
extends Enum<PageSize>

Represents a specific page size.

The value of this page size determines the number of items that can be displayed on a single page.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
L	Large page size with maximum elements per page set to 10000
M	Medium page size with maximum elements per page set to 1000
S	Small page size with maximum elements per page set to 100

Method Summary

Modifier and Type	Method	Description
int	getValue()	Retrieves the number of elements the page can contain.
static PageSize	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PageSize[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

S

public static final PageSize S

Small page size with maximum elements per page set to 100

M

public static final PageSize M

Medium page size with maximum elements per page set to 1000

L

public static final PageSize L

Large page size with maximum elements per page set to 10000

Method Details

values

public static PageSize[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PageSize valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Retrieves the number of elements the page can contain.

The value can be configured using the company.rs.pageSize.{size} property; if not defined, the returned value will be the default value set for the specific page size.

Returns:

the maximum number of elements a page can contain.