Hyphenation (Lucene 10.5.0 common API)
Description: declaration: package: org.apache.lucene.analysis.compound.hyphenation, class: Hyphenation

Package org.apache.lucene.analysis.compound.hyphenation

# Class Hyphenation

java.lang.Object
org.apache.lucene.analysis.compound.hyphenation.Hyphenation

public class Hyphenation extends Object
This class represents a hyphenated word.

This class has been taken from the Apache FOP project (http://xmlgraphics.apache.org/fop/). They have been slightly modified.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `int[]`
  `getHyphenationPoints()`
  `int`
  `length()`

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Method Details

  - ### length

    public int length()
    Returns:
      the number of hyphenation points in the word

  - ### getHyphenationPoints

    public int[] getHyphenationPoints()
    Returns:
      the hyphenation points