FTUnit (BaseX Core 11.6 API)

java.lang.Object
- java.lang.Enum<FTUnit>
- - org.basex.util.ft.FTUnit

All Implemented Interfaces:

Serializable, Comparable<FTUnit>
```
public enum FTUnit
extends Enum<FTUnit>
```
Full-text units.

Author:

BaseX Team 2005-24, BSD License, Christian Gruen

Enum Constant Summary

Enum Constants
Enum Constant Description

PARAGRAPHS
Paragraph unit.

SENTENCES
Sentence unit.

WORDS
Word unit.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`toString()`	Returns a string representation.
`static FTUnit`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static FTUnit[]`	`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, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - WORDS
```
public static final FTUnit WORDS
```
    Word unit.
  - SENTENCES
```
public static final FTUnit SENTENCES
```
    Sentence unit.
  - PARAGRAPHS
```
public static final FTUnit PARAGRAPHS
```
    Paragraph unit.
- Method Detail
  - values
```
public static FTUnit[] 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 (FTUnit c : FTUnit.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static FTUnit 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
  - toString
```
public String toString()
```
    Returns a string representation.
    
    Overrides:
    
    toString in class Enum<FTUnit>
    
    Returns:
    
    string representation