Package org.kiwiproject.search

Enum KiwiSearching.PageNumberingScheme

java.lang.Object

java.lang.Enum<KiwiSearching.PageNumberingScheme>

org.kiwiproject.search.KiwiSearching.PageNumberingScheme

All Implemented Interfaces:

Serializable, Comparable<KiwiSearching.PageNumberingScheme>

Enclosing class:

KiwiSearching

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

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

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
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.
static KiwiSearching.PageNumberingScheme	valueOf(String name)	Returns the enum constant of this type with the specified name.
static KiwiSearching.PageNumberingScheme[]	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

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 Detail

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.)

Method Detail

values

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

Returns:

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

valueOf

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

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