Package org.basex.util.ft

Enum Class FTBigUnit

java.lang.Object

java.lang.Enum<FTBigUnit>

org.basex.util.ft.FTBigUnit

All Implemented Interfaces:

Serializable, Comparable<FTBigUnit>, java.lang.constant.Constable

public enum FTBigUnit
extends Enum<FTBigUnit>

Full-text big units.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

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
PARAGRAPH	Paragraph unit.
SENTENCE	Sentence unit.

Method Summary

Modifier and Type	Method	Description
String	toString()	Returns a string representation.
FTUnit	unit()	Returns the unit.
static FTBigUnit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FTBigUnit[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SENTENCE

public static final FTBigUnit SENTENCE

Sentence unit.

PARAGRAPH

public static final FTBigUnit PARAGRAPH

Paragraph unit.

Method Details

values

public static FTBigUnit[] 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 FTBigUnit 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

unit

public FTUnit unit()

Returns the unit.

Returns:

unit

toString

public String toString()

Returns a string representation.

Overrides:

toString in class Enum<FTBigUnit>

Returns:

string representation