Package org.kiwiproject.search

Enum Class KiwiSearching.PageNumberingScheme

java.lang.Object

java.lang.Enum<KiwiSearching.PageNumberingScheme>

org.kiwiproject.search.KiwiSearching.PageNumberingScheme

All Implemented Interfaces:

Serializable, Comparable<KiwiSearching.PageNumberingScheme>, Constable

Enclosing class:

KiwiSearching

public static enum KiwiSearching.PageNumberingScheme
extends Enum<KiwiSearching.PageNumberingScheme>

Enum that represents either zero or one-based page numbering scheme.

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
ONE_BASED	Page numbers start at one.
ZERO_BASED	Page numbers start at zero.

Field Summary

Fields

Modifier and Type	Field	Description
final int	minimumPageNumber
final String	pageNumberError

Method Summary

Modifier and Type	Method	Description
void	checkPageNumber(int pageNumber)	Check the given page number for this scheme's minimum page number.
int	getMinimumPageNumber()
String	getPageNumberError()
static KiwiSearching.PageNumberingScheme	valueOf(String name)	Returns the enum constant of this class with the specified name.
static KiwiSearching.PageNumberingScheme[]	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

ZERO_BASED

public static final KiwiSearching.PageNumberingScheme ZERO_BASED

Page numbers start at zero.

ONE_BASED

public static final KiwiSearching.PageNumberingScheme ONE_BASED

Page numbers start at one.

Field Details

pageNumberError

public final String pageNumberError

Implementation Note:

Allow access through a traditional getter method or via a public field (which is perfectly fine since this is an immutable String.)

minimumPageNumber

public final int minimumPageNumber

Implementation Note:

Allow access through traditional getter method or via public (immutable) field

Method Details

values

public static KiwiSearching.PageNumberingScheme[] 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 KiwiSearching.PageNumberingScheme 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

checkPageNumber

public void checkPageNumber(int pageNumber)

Check the given page number for this scheme's minimum page number.

Parameters:

pageNumber - the page number to check

Throws:

IllegalArgumentException - if the given page number is not valid

getPageNumberError

public String getPageNumberError()

Implementation Note:

Allow access through a traditional getter method or via a public field (which is perfectly fine since this is an immutable String.)

getMinimumPageNumber

public int getMinimumPageNumber()

Implementation Note:

Allow access through traditional getter method or via public (immutable) field