net.sf.mmm.util.text.base

Class HyphenationPatternPosition

java.lang.Object

net.sf.mmm.util.text.base.HyphenationPatternPosition

public class HyphenationPatternPosition
extends Object

A HyphenationPatternPosition represents a ranked position of a potential hyphenation of a HyphenationPattern.

Since:

2.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
int	index the index of the hyphenation-position in the pattern (without numbers).
int	ranking The ranking a hyphenation at the represented index.

Constructor Summary

Constructors

Constructor and Description
HyphenationPatternPosition(int index, int rankink) The constructor.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

index

public final int index

the index of the hyphenation-position in the pattern (without numbers). A value of 0 indicates a hyphenation before the first character.

ranking

public final int ranking

The ranking a hyphenation at the represented index. A higher value over-rules a lower value of a previous pattern. Odd values indicate a hyphenation while even values indicate

Constructor Detail

HyphenationPatternPosition

public HyphenationPatternPosition(int index,
                                  int rankink)

The constructor.

Parameters:

index - is the index.

rankink - is the ranking.