A B C D E F G H I L M N O P Q R S T U V W

A

add(int[], int, int, int) - Method in class au.id.pbw.hyfo.hyph.BigTernaryTree
Inserts the subkey represented by the array of Unicode codepoints and associated data.
add_alias(String, String) - Method in class au.id.pbw.hyfo.hyph.HyphenationTreeCache
Adds the given alias for the given Locale-like string, and returns the HyphenationTree corresponding to the Locale, if one exists.
add_break_minima(BreakMinima) - Method in class au.id.pbw.hyfo.hyph.AlphabetBuilder
Adds a BreakMinima for this alphabet.
add_class(String) - Method in class au.id.pbw.hyfo.hyph.AlphabetBuilder
Adds a character class for the Alphabet.
add_hyphen_char(int) - Method in class au.id.pbw.hyfo.hyph.AlphabetBuilder
Adds the canonical hyphen character for this alphabet.
addFileset(FileSet) - Method in class au.id.pbw.hyfo.anttasks.SerializeHyphenationTrees
Adds a set of pattern files (nested fileset attribute).
alpha_builder - Variable in class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
The AlphabetBuilder used to construct the Alphabet instance for use with this tree.
Alphabet - Class in au.id.pbw.hyfo.hyph
Represents a alphabet based on a set of character classes.
Alphabet(int, BreakMinima, Map<Integer, Integer>, int[], boolean) - Constructor for class au.id.pbw.hyfo.hyph.Alphabet
Creates a new instance of Alphabet from the given codepoint to character class code mapping and the array of codepoints indexed by the character class code for each valid codepoint.
alphabet - Variable in class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
The Alphabet for the tree being constructed.
AlphabetBuilder - Class in au.id.pbw.hyfo.hyph
This class builds and returns Alphabet objects.
AlphabetBuilder() - Constructor for class au.id.pbw.hyfo.hyph.AlphabetBuilder
Creates a new instance of AlphabetBuilder for an Alphabet with the default number of classes.
AlphabetBuilder(int) - Constructor for class au.id.pbw.hyfo.hyph.AlphabetBuilder
Creates a new instance of AlphabetBuilder for an alphabet with the given number of character classes.
au.id.pbw.hyfo.anttasks - package au.id.pbw.hyfo.anttasks
This package contains any classes which implement Ant tasks specific to the HyFo build process.
au.id.pbw.hyfo.hyph - package au.id.pbw.hyfo.hyph
The main package of HyFo.
au.id.pbw.hyfo.unicode - package au.id.pbw.hyfo.unicode
The au.id.pbw.hyfo.unicode package provides support for processing supplementary Unicode characters.
au.id.pbw.hyfo.version - package au.id.pbw.hyfo.version
Single class to provide version information to other Folio classes and to the Folio build process.

B

BigTernaryTree - Class in au.id.pbw.hyfo.hyph
A TernaryTree whose node count may exceed Short.MAX_VALUE.
BigTernaryTree(TernaryTreeDataStore) - Constructor for class au.id.pbw.hyfo.hyph.BigTernaryTree
Creates a new instance of BigTernaryTree
BigTernaryTree.TernaryIterator - Class in au.id.pbw.hyfo.hyph
Defines an in-order Iterator over the tree.
BigTernaryTree.TernaryIterator() - Constructor for class au.id.pbw.hyfo.hyph.BigTernaryTree.TernaryIterator
Constructs a new in-order iterator.
BigTernaryTree.TernaryTreeWalker - Class in au.id.pbw.hyfo.hyph
This process walks the tree and feeds TreeElements into a blocking queue for reading by an Iterator.
BigTernaryTree.TernaryTreeWalker(Thread, ArrayBlockingQueue<TreeElement>) - Constructor for class au.id.pbw.hyfo.hyph.BigTernaryTree.TernaryTreeWalker
Constructs a new tree walker.
BreakMinima - Class in au.id.pbw.hyfo.hyph
Represents the minimum number of characters allowable before and after a hyphenation line-break.
BreakMinima(byte, byte) - Constructor for class au.id.pbw.hyfo.hyph.BreakMinima
Creates a new instance of BreakMinima, with the given minimum number for characters before and after the hyphenation.
build_tree(Map<String, HyphenBreak[]>, HyphenDataCache) - Method in class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
Builds and returns a TernaryTree mapping string keys to arrays of HyphenBreaks.
builder_package_name - Variable in class au.id.pbw.hyfo.anttasks.SerializeHyphenationTrees
The hyphenation tree builders package name.
builder_path_name - Variable in class au.id.pbw.hyfo.anttasks.SerializeHyphenationTrees
The path name corresponding to package name of the hyphenation classes.

C

canonical_codept_of_char_class(int) - Method in class au.id.pbw.hyfo.hyph.Alphabet
Returns the canonical codepoint represented by the given character class char_class, or NUL if no codepoint corresponds to the given class code value.
canonicalize(int) - Method in class au.id.pbw.hyfo.hyph.Alphabet
Returns the canonical codepoint equivalent to the argument codepoint in this alphabet.
char_class2canon - Variable in class au.id.pbw.hyfo.hyph.Alphabet
Maps a character class code to its canonical codepoint.
char_class_of_codept(int) - Method in class au.id.pbw.hyfo.hyph.Alphabet
Returns the character class code, 0 <= cc_code < number of character classes, corresponding to the given codepoint.
characters(char[], int, int) - Method in class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
Processes a node of characters from the resource file.
check_nobreak_text - Variable in class au.id.pbw.hyfo.hyph.HyphenBreak
Flags this HyphenBreak as one which may have a complex break with text replacement.
check_prefix(String, String, List<String>) - Method in class au.id.pbw.hyfo.hyph.HyphenationTreeCache
Gets the HyphenationTree matched by the the prefix of locale.
CodepointArrays - Class in au.id.pbw.hyfo.unicode
Static methods for manipulating arrays of codepoints.
codept2char_class - Variable in class au.id.pbw.hyfo.hyph.Alphabet
Maps a codepoint to a character class code.
CODEPTS - Static variable in class au.id.pbw.hyfo.unicode.CodepointArrays
The index of the array of codepoints within the int[][] returned by CodepointArrays.to_codepoint_arrays(java.lang.CharSequence).
createClasspath() - Method in class au.id.pbw.hyfo.anttasks.SerializeHyphenationTrees
Ant magic to create a class path.

D

DEFAULT_ALPHABET_SIZE - Static variable in class au.id.pbw.hyfo.hyph.AlphabetBuilder
The default number of character classes in an alphabet.
default_hyphen - Variable in class au.id.pbw.hyfo.hyph.Alphabet
A HyphenBreak with default values for this alphabet.
DEFAULT_HYPHEN_CHAR - Static variable in class au.id.pbw.hyfo.hyph.AlphabetBuilder
The default hyphen for this alphabet.
default_modifier - Variable in class au.id.pbw.hyfo.hyph.Alphabet
The default Modifier for this alphabet.
DEFAULT_WEIGHT - Static variable in class au.id.pbw.hyfo.hyph.HyphenBreak
The default weight for a HyphenBreak.
DEFAULT_WEIGHT - Static variable in class au.id.pbw.hyfo.hyph.Modifier
The default modifier break weight.
deserialize_tree(String) - Static method in class au.id.pbw.hyfo.hyph.HyphenationTree
Deserializes a HyphenationTree, given an id, normally a language or language_country specifier, by which a serialized tree can be identified.
dump_exceptions(PrintStream) - Method in class au.id.pbw.hyfo.hyph.HyphenationTree
Formats and dumps the contents of the exceptions tree to the nominated PrintStream.
dump_patterns(PrintStream) - Method in class au.id.pbw.hyfo.hyph.HyphenationTree
Formats and dumps the contents of the patterns tree to the nominated PrintStream.
dump_ternary_tree(TernaryTree, HyphenDataCache, PrintStream) - Method in class au.id.pbw.hyfo.hyph.HyphenationTree
Formats and dumps the contents of the nominated tree to the nominated PrintStream.

E

end_seen - Variable in class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
Used by HyphenationTreeBuilder.process_text_element(java.lang.StringBuilder, au.id.pbw.hyfo.hyph.TextElement, au.id.pbw.hyfo.hyph.InstanceType).
endElement(String, String, String) - Method in class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
Process an end element from the resource file.
ETX - Static variable in class au.id.pbw.hyfo.hyph.AlphabetBuilder
The ETX is used as an end-of-word marker in patterns.
ETX_CLASS - Static variable in class au.id.pbw.hyfo.hyph.AlphabetBuilder
The character class of ETX is 1
ETX_CLASS_INTEGER - Static variable in class au.id.pbw.hyfo.hyph.AlphabetBuilder
ETX_CLASS as an Integer
exception_data - Variable in class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
The TernaryTreeDataStore associated with the exceptions tree.
exceptions - Variable in class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
The set of exceptions for this tree.
execute() - Method in class au.id.pbw.hyfo.anttasks.SerializeHyphenationTrees
The execute method from the ant Task class.

F

failure(String, List<String>) - Method in class au.id.pbw.hyfo.hyph.HyphenationTreeCache
Adds all of the elements of the argument list to the failed map, and returns null.
FAIR - Static variable in class au.id.pbw.hyfo.hyph.BigTernaryTree.TernaryIterator
User fair queueing.
FAIR - Static variable in class au.id.pbw.hyfo.hyph.ShortTernaryTree.TernaryIterator
 
find(int[]) - Method in class au.id.pbw.hyfo.hyph.BigTernaryTree
Find the data pointer associated with a given key, or 0 if the key does not occur .
find(int[]) - Method in class au.id.pbw.hyfo.hyph.ShortTernaryTree
Find the data pointer associated with a given key, or 0 if the key does not occur .
find(int[]) - Method in interface au.id.pbw.hyfo.hyph.TernaryTree
Finds the node corresponding to the given key.
find_next(int[], int, int) - Method in class au.id.pbw.hyfo.hyph.BigTernaryTree
Returns a Subsearch representing a position in the tree at which non-null DATA was found while tracing a given key.
find_next(int[], int, int) - Method in class au.id.pbw.hyfo.hyph.ShortTernaryTree
Returns a Subsearch representing a position in the tree at which non-null DATA was found while tracing a given key.
find_next(int[], int, int) - Method in interface au.id.pbw.hyfo.hyph.TernaryTree
Returns a Subsearch representing the psotion in the tree of the next non-null data discovered in traversing the given key.
format_data(HyphenBreak[]) - Method in class au.id.pbw.hyfo.hyph.HyphenationTree
Formats an array of HyphenBreaks into a display string.
format_data(int) - Method in class au.id.pbw.hyfo.hyph.HyphenDataCache
Returns the data value as a string.
format_data(int) - Method in interface au.id.pbw.hyfo.hyph.TernaryTreeDataStore
Format a item of data, represented by an integer index, into a string.
format_key(int[]) - Method in class au.id.pbw.hyfo.hyph.HyphenationTree
Format the given key, represented as an array of codepoints, into a string.
format_key(int[]) - Method in class au.id.pbw.hyfo.hyph.HyphenDataCache
Returns the key value as a string.
format_key(int[]) - Method in interface au.id.pbw.hyfo.hyph.TernaryTreeDataStore
Format a data key, represented as a array of codepoints, into a string.

G

get_after() - Method in class au.id.pbw.hyfo.hyph.BreakMinima
Gets the minimum number of characters after a hyphenation break.
get_alphabet() - Method in class au.id.pbw.hyfo.hyph.AlphabetBuilder
Returns the Alphabet constructed from the character classes.
get_before() - Method in class au.id.pbw.hyfo.hyph.BreakMinima
Gets the minimum number of characters before a hyphenation break.
get_breakpoint_count() - Method in class au.id.pbw.hyfo.hyph.HyphenatedWord
Gets the number of breakpoints in this HyphenatedWord.
get_cache_instance() - Static method in class au.id.pbw.hyfo.hyph.HyphenationTreeCache
Returns the singleton instance of the cache, creating an instance if one does not currently exist.
get_char_classes_breakpoints() - Method in class au.id.pbw.hyfo.hyph.HyphenatedWord
Gets the array of hyphenation possibilities corresponding to the codepoints of the original word.
get_codept2char_class_map() - Method in class au.id.pbw.hyfo.hyph.Alphabet
Gets the Map of codepoint to character class code.
get_data_ptr() - Method in class au.id.pbw.hyfo.hyph.Subsearch
Gets the data_ptr value from the subsearch node.
get_default_hyphen() - Method in class au.id.pbw.hyfo.hyph.Alphabet
Gets a reference to the default_hyphen generated for this alphabet.
get_default_modifier() - Method in class au.id.pbw.hyfo.hyph.Alphabet
Gets a reference to the default_modifier for this alphabet.
get_default_modifier() - Method in class au.id.pbw.hyfo.hyph.Modifier
Gets the default Modifier.
get_END_ELEMENT() - Static method in class au.id.pbw.hyfo.hyph.TreeElement
Gets the END element from a tree walker.
get_equal_node(int) - Method in class au.id.pbw.hyfo.hyph.BigTernaryTree
Gets the node pointed to by the equal pointer of the given node.
get_equal_node(int) - Method in class au.id.pbw.hyfo.hyph.ShortTernaryTree
 
get_equal_node(int) - Method in interface au.id.pbw.hyfo.hyph.TernaryTree
Gets the node number from the equal link of the given node.
get_fop_compatible_points() - Method in class au.id.pbw.hyfo.hyph.HyphenatedWord
Gets the Fop-compatible array of breakpoint positions in the word.
get_fop_post_hyphen(int) - Method in class au.id.pbw.hyfo.hyph.HyphenatedWord
Gets the suffix substring of the original word from the given offset, inclusive, to the end of the word.
get_fop_pre_hyphen(int) - Method in class au.id.pbw.hyfo.hyph.HyphenatedWord
Gets the prefix substring of the original word up to, but excluding, the given offset.
get_hyphenation_tree(File) - Method in class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
Builds and returns a TernaryTree from the resource file provided.
get_hyphenation_tree(String) - Method in class au.id.pbw.hyfo.hyph.HyphenationTreeCache
Gets the HyphenationTree corresponding to the given locale argument, or null if none is found.
get_index() - Method in class au.id.pbw.hyfo.hyph.Subsearch
Gets the index of the character associated with the node in this subsearch.
get_key(List<Integer>) - Method in class au.id.pbw.hyfo.hyph.BigTernaryTree
Constructs the key from the series of entries in the key codepoint stack.
get_key() - Method in class au.id.pbw.hyfo.hyph.BigTernaryTree.TernaryTreeWalker
Constructs the key from the series of entries in the key codepoint stack.
get_key(List<Integer>) - Method in class au.id.pbw.hyfo.hyph.ShortTernaryTree
 
get_key() - Method in class au.id.pbw.hyfo.hyph.ShortTernaryTree.TernaryTreeWalker
 
get_key() - Method in class au.id.pbw.hyfo.hyph.Subsearch
Gets the key used in this search.
get_key(List<Integer>) - Method in interface au.id.pbw.hyfo.hyph.TernaryTree
Derive a string from the list of codepoints representing the key.
get_key(TernaryTreeDataStore) - Method in class au.id.pbw.hyfo.hyph.TreeElement
Gets the key of this element, formatted by a TernaryTreeDataStore instance.
get_mod_ref(ModifierReference, InstanceType) - Method in class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
Gets the HyphenBreak corresponding to the Modifier named by this ModifierReference, in the named context.
get_modifier(String) - Method in class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
Gets a known Modifier with a given id, which is generally the no-break string.
get_neutral_hyphen() - Method in class au.id.pbw.hyfo.hyph.Alphabet
Gets a reference to the neutral_hyphen generated for this alphabet.
get_node() - Method in class au.id.pbw.hyfo.hyph.Subsearch
Gets the last node located in the search.
get_node() - Method in class au.id.pbw.hyfo.hyph.TreeElement
Gets the node number from the element.
get_node_data_ptr(int) - Method in class au.id.pbw.hyfo.hyph.BigTernaryTree
Gets the node data.
get_node_data_ptr(int) - Method in class au.id.pbw.hyfo.hyph.ShortTernaryTree
Gets the node data.
get_node_data_ptr(int) - Method in interface au.id.pbw.hyfo.hyph.TernaryTree
Get the data pointer value from the nominated node.
get_string_breakpoints() - Method in class au.id.pbw.hyfo.hyph.HyphenatedWord
Gets the array of hyphenation possibilities corresponding to the String representation of the word being hyphenated.
get_weight() - Method in class au.id.pbw.hyfo.hyph.HyphenBreak
Gets the weight of this HyphenBreak.
getFilesets() - Method in class au.id.pbw.hyfo.anttasks.SerializeHyphenationTrees
Returns the current list of filesets.
getFormattedTag() - Static method in class au.id.pbw.hyfo.version.Version
Get the formatted tag version of HyFo.
getVersion() - Static method in class au.id.pbw.hyfo.version.Version
Get a displayable HyFo version string.

H

hasNext() - Method in class au.id.pbw.hyfo.hyph.BigTernaryTree.TernaryIterator
Does the iterator have anotehr element?
hasNext() - Method in class au.id.pbw.hyfo.hyph.ShortTernaryTree.TernaryIterator
 
hyph_component - Static variable in class au.id.pbw.hyfo.anttasks.SerializeHyphenationTrees
The last part of the HyFo package name for hyphenation classes
hyphen_breaks - Variable in class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
A cache of HyphenBreak objects used in constructing the tree.
hyphen_char - Variable in class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
The codepoint of the hyphen character used with the Alphabet of the HyphenationTree being built.
hyphen_codept - Variable in class au.id.pbw.hyfo.hyph.Alphabet
The hyphen character for this alphabet.
HYPHEN_MARKER - Static variable in class au.id.pbw.hyfo.hyph.HyphenMarker
The named singleton instance of HyphenMarker.
hyphenate(String) - Method in class au.id.pbw.hyfo.hyph.HyphenationTree
Gets the hyphenation data for the given word as a HyphenatedWord.
HyphenatedWord - Class in au.id.pbw.hyfo.hyph
Represents a hyphenated-word, derived from an original word, with its hyphenation possibilities.
HyphenatedWord(int[], int[], String, HyphenBreak[], Alphabet) - Constructor for class au.id.pbw.hyfo.hyph.HyphenatedWord
Creates a new instance of HyphenatedWord from the given arrays.
HyphenatedWord(String) - Constructor for class au.id.pbw.hyfo.hyph.HyphenatedWord
Creates a NULL instance of HyphenatedWord from the given word.
HyphenationException - Exception in au.id.pbw.hyfo.hyph
Exceptions encountered in hyphenation.
HyphenationException(String) - Constructor for exception au.id.pbw.hyfo.hyph.HyphenationException
Creates a new HyphenationException.
HyphenationException(Throwable) - Constructor for exception au.id.pbw.hyfo.hyph.HyphenationException
Creates a new HyphenationException.
HyphenationException(String, Throwable) - Constructor for exception au.id.pbw.hyfo.hyph.HyphenationException
Creates a new HyphenationException.
HyphenationTree - Class in au.id.pbw.hyfo.hyph
Represents a tree of hyphenation data and associated structures.
HyphenationTree(Alphabet, TernaryTree, HyphenDataCache, TernaryTree, HyphenDataCache) - Constructor for class au.id.pbw.hyfo.hyph.HyphenationTree
Creates a new instance of HyphenationTree, from a set of components which have been constructed by processing a hyphenation pattern file.
HyphenationTreeBuilder - Class in au.id.pbw.hyfo.hyph
Builds a HyphenationTree from an input pattern file.
HyphenationTreeBuilder() - Constructor for class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
Creates a new instance of HyphenationTreeBuilder
HyphenationTreeBuilder.Element - Enum in au.id.pbw.hyfo.hyph
An enum of the elements n a resource file.
HyphenationTreeCache - Class in au.id.pbw.hyfo.hyph
A singleton class which caches instances of HyphenationTree.
HyphenatorDisplay - Class in au.id.pbw.hyfo.hyph
Static methods to display hyphenations from instances of HyphenatedWord.
HyphenBreak - Class in au.id.pbw.hyfo.hyph
This class represents a possible hyphenation break.
HyphenBreak(Alphabet) - Constructor for class au.id.pbw.hyfo.hyph.HyphenBreak
Constructs a HyphenBreak with the default weight and default Modifier values.
HyphenBreak(byte, Alphabet) - Constructor for class au.id.pbw.hyfo.hyph.HyphenBreak
Constructs a HyphenBreak with the given weight and default Modifier values.
HyphenBreak(Modifier) - Constructor for class au.id.pbw.hyfo.hyph.HyphenBreak
Constructs a HyphenBreak with the given Modifier.
HyphenBreak(char, Alphabet) - Constructor for class au.id.pbw.hyfo.hyph.HyphenBreak
Constructs a HyphenBreak with a weight derived from the given character, and default Modifier values.
HyphenDataCache - Class in au.id.pbw.hyfo.hyph
The class caches the data for an associated HyphenationTree.
HyphenDataCache() - Constructor for class au.id.pbw.hyfo.hyph.HyphenDataCache
Creates a new instance of HyphenDataCache
HyphenInhibitor - Class in au.id.pbw.hyfo.hyph
Represents an inhibiting value for a hyphenation break point.
HyphenInhibitor(Byte, Alphabet) - Constructor for class au.id.pbw.hyfo.hyph.HyphenInhibitor
Creates a new instance of HyphenInhibitor
HyphenMarker - Class in au.id.pbw.hyfo.hyph
The attribute key for an instance of HyphenBreak, containing the details of a potential hyphenation break in an AttributedString.
HyphenMarker(String) - Constructor for class au.id.pbw.hyfo.hyph.HyphenMarker
Attempts to create a new instance of HyphenMarker

I

ignorableWhitespace(char[], int, int) - Method in class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
Processes ignorable white space from the resource file.
INDICES - Static variable in class au.id.pbw.hyfo.unicode.CodepointArrays
The index of the array of offsets within the int[][] returned by CodepointArrays.to_codepoint_arrays(java.lang.CharSequence).
init() - Method in class au.id.pbw.hyfo.anttasks.SerializeHyphenationTrees
initialize_data_array() - Method in class au.id.pbw.hyfo.hyph.BigTernaryTree
Finalizes the data initialization of this BigTernaryTree.
initialize_data_array() - Method in class au.id.pbw.hyfo.hyph.ShortTernaryTree
Finalizes the data initialization of this ShortTernaryTree.
initialize_data_array() - Method in interface au.id.pbw.hyfo.hyph.TernaryTree
When all the data for the tree has been added, initialize the tree data to minimize space requirements.
insert_mid(String[], Map<String, Integer>, int, int) - Method in class au.id.pbw.hyfo.hyph.BigTernaryTree
Given a ascending sorted array of keys, a map associating a datum with each key, the index of the least key to be inserted (lo) and the index of the greatest key to be inserted (hi), perform a balanced add of all of the keys between the least and the greatest, inclusive.
InstanceType - Enum in au.id.pbw.hyfo.hyph
Types of instance in tree builders.
iterator() - Method in class au.id.pbw.hyfo.hyph.BigTernaryTree
Gets a TernaryIterator for in-order traversal of the tree.
iterator() - Method in class au.id.pbw.hyfo.hyph.ShortTernaryTree
 
iterator() - Method in interface au.id.pbw.hyfo.hyph.TernaryTree
Gets an in-order iterator over the tree.

L

log - Variable in class au.id.pbw.hyfo.hyph.HyphenationTreeCache
The Logger instance for the cache.

M

main(String[]) - Static method in class au.id.pbw.hyfo.version.Version
main() exists as a convenience for retrieving the source version during Ant builds.
make_key() - Method in class au.id.pbw.hyfo.hyph.HyphenBreak
Constructs a String key from the HyphenBreak.
max_codepoint - Variable in class au.id.pbw.hyfo.hyph.Alphabet
The maximum codepoint of any alphabet character.
min_after - Variable in class au.id.pbw.hyfo.hyph.Alphabet
The mimimum number of character following a hyphen.
min_before - Variable in class au.id.pbw.hyfo.hyph.Alphabet
The minimum number of character preceding a hyphen.
min_codepoint - Variable in class au.id.pbw.hyfo.hyph.Alphabet
The minimum codepoint of any alphabet character.
minima - Variable in class au.id.pbw.hyfo.hyph.Alphabet
The minimum number of characters allowed before and after hyphenation for this Alphabet.
Modifier - Class in au.id.pbw.hyfo.hyph
This class represents the modification to a word which occurs when it is hyphenated.
Modifier(Alphabet) - Constructor for class au.id.pbw.hyfo.hyph.Modifier
Constructs the default modifier.
Modifier(Alphabet, String, String, String) - Constructor for class au.id.pbw.hyfo.hyph.Modifier
Constructs a modifier with the given no-break, pre-break and post-break strings.
modifier_id - Variable in class au.id.pbw.hyfo.hyph.ModifierReference
The ID od this reference.
ModifierReference - Class in au.id.pbw.hyfo.hyph
Represents a reference to a Modifier embedded in a text string.
ModifierReference(String) - Constructor for class au.id.pbw.hyfo.hyph.ModifierReference
Creates a new instance of ModifierReference
modifiers - Variable in class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
The modifiers for this tree.

N

neutral_hyphen - Variable in class au.id.pbw.hyfo.hyph.Alphabet
A HyphenBreak with neutral values.
NEUTRAL_WEIGHT - Static variable in class au.id.pbw.hyfo.hyph.HyphenBreak
The weight for a neutral break; that is, a point which neither supports nor inhibits hyphenation.
next() - Method in class au.id.pbw.hyfo.hyph.BigTernaryTree.TernaryIterator
Gets the next element from the itertor, or null if the iterator is exhausted.
next() - Method in class au.id.pbw.hyfo.hyph.ShortTernaryTree.TernaryIterator
 
next_prefix(String) - Method in class au.id.pbw.hyfo.hyph.HyphenationTreeCache
Returns the next prefix of super_prefix, derived by stripping the last underscore-separated element off super_prefix.
nobreak - Variable in class au.id.pbw.hyfo.hyph.HyphenBreak
The text before line-breaking.
nobreak - Variable in class au.id.pbw.hyfo.hyph.Modifier
The text before line-breaking.
nobreak_post - Variable in class au.id.pbw.hyfo.hyph.Modifier
The nobreak text following the breakpoint.
nobreak_pre - Variable in class au.id.pbw.hyfo.hyph.Modifier
The nobreak text preceding the breakpoint.
normalized_locale(String) - Method in class au.id.pbw.hyfo.hyph.HyphenationTreeCache
Normalizes the Locale-like identifier.

O

obtain_hyphen_break(HyphenBreak) - Method in class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
Returns a HyphenBreak equal to the given argument.

P

pattern_data - Variable in class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
The TernaryTreeDataStore associated with the patterns tree.
PatternElement - Interface in au.id.pbw.hyfo.hyph
Represents a pattern element, which can be either a String or an embedded ModifierReference.
patterns - Variable in class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
The set of patterns for this tree.
post_brkpt - Variable in class au.id.pbw.hyfo.hyph.HyphenBreak
The post-break text of this HyphenBreak.
postbreak - Variable in class au.id.pbw.hyfo.hyph.Modifier
The text following the line-break, after line-breaking.
pre_brkpt - Variable in class au.id.pbw.hyfo.hyph.HyphenBreak
The pre-break text of this HyphenBreak.
prebreak - Variable in class au.id.pbw.hyfo.hyph.Modifier
The text preceding the line-break, after line-breaking.
process_instance(InstanceType, List<PatternElement>, Alphabet, Map<String, HyphenBreak[]>) - Method in class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
Process a pattern instance, adding it to the given map.
process_text_element(StringBuilder, TextElement, InstanceType) - Method in class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
Process a text element from an exception or hyphenation pattern.
process_text_instance(InstanceType, TextElement, Alphabet, Map<String, HyphenBreak[]>) - Method in class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
Process a text instance, adding it to the given map.

Q

Q_CAPACITY - Static variable in class au.id.pbw.hyfo.hyph.BigTernaryTree.TernaryIterator
The initial capacity of the
Q_CAPACITY - Static variable in class au.id.pbw.hyfo.hyph.ShortTernaryTree.TernaryIterator
 

R

readResolve() - Method in class au.id.pbw.hyfo.hyph.HyphenMarker
Deserialises instance to the only valid constant.
remove() - Method in class au.id.pbw.hyfo.hyph.BigTernaryTree.TernaryIterator
This operation is unsupported.
remove() - Method in class au.id.pbw.hyfo.hyph.ShortTernaryTree.TernaryIterator
 
replace_post_brkpt - Variable in class au.id.pbw.hyfo.hyph.HyphenBreak
The replacement text following the hyphen position that replaces the HyphenBreak.post_brkpt text.
replace_pre_brkpt - Variable in class au.id.pbw.hyfo.hyph.HyphenBreak
The replacement text preceding the hyphen position that replaces the HyphenBreak.pre_brkpt text.
requires_codepoints - Variable in class au.id.pbw.hyfo.hyph.AlphabetBuilder
Are any alphabet characters outside the BMP; that is, does the alphabet require the use of codepoints rather than characters.
reset_aliases() - Method in class au.id.pbw.hyfo.hyph.HyphenationTreeCache
Creates a new, empty instance of aliases.
reset_cache() - Method in class au.id.pbw.hyfo.hyph.HyphenationTreeCache
Creates new, empty instances of matches, superstring_matches, failed and aliases.
reset_cache_searches() - Method in class au.id.pbw.hyfo.hyph.HyphenationTreeCache
Creates new, empty instances of matches, superstring_matches and failed.
run() - Method in class au.id.pbw.hyfo.hyph.BigTernaryTree.TernaryTreeWalker
The run method of the Runnable interface.
run() - Method in class au.id.pbw.hyfo.hyph.ShortTernaryTree.TernaryTreeWalker
 

S

serial_file_extension - Static variable in class au.id.pbw.hyfo.anttasks.SerializeHyphenationTrees
The extension of serialized hyphenation tree files.
SerializeHyphenationTrees - Class in au.id.pbw.hyfo.anttasks
An ant Task to serialize HyphenationTrees.
SerializeHyphenationTrees() - Constructor for class au.id.pbw.hyfo.anttasks.SerializeHyphenationTrees
Constructs a new serializer.
setClassname(String) - Method in class au.id.pbw.hyfo.anttasks.SerializeHyphenationTrees
Ant magic to set the class name.
setClasspathref(Reference) - Method in class au.id.pbw.hyfo.anttasks.SerializeHyphenationTrees
Ant magic to set the classpath.
setTarget_dir(String) - Method in class au.id.pbw.hyfo.anttasks.SerializeHyphenationTrees
Sets the target directory
ShortTernaryTree - Class in au.id.pbw.hyfo.hyph
 
ShortTernaryTree(int) - Constructor for class au.id.pbw.hyfo.hyph.ShortTernaryTree
Creates a new instance of ShortTernaryTree
ShortTernaryTree.TernaryIterator - Class in au.id.pbw.hyfo.hyph
 
ShortTernaryTree.TernaryIterator() - Constructor for class au.id.pbw.hyfo.hyph.ShortTernaryTree.TernaryIterator
 
ShortTernaryTree.TernaryTreeWalker - Class in au.id.pbw.hyfo.hyph
 
ShortTernaryTree.TernaryTreeWalker(Thread, ArrayBlockingQueue<TreeElement>) - Constructor for class au.id.pbw.hyfo.hyph.ShortTernaryTree.TernaryTreeWalker
 
show_string_breakpoints(HyphenatedWord) - Static method in class au.id.pbw.hyfo.hyph.HyphenatorDisplay
Gets a string representing possible hyphenation breaks.
show_string_hyphens(HyphenatedWord) - Static method in class au.id.pbw.hyfo.hyph.HyphenatorDisplay
Gets a string representing possible hyphenation breaks.
start_seen - Variable in class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
Used by HyphenationTreeBuilder.process_text_element(java.lang.StringBuilder, au.id.pbw.hyfo.hyph.TextElement, au.id.pbw.hyfo.hyph.InstanceType).
startElement(String, String, String, Attributes) - Method in class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
Process a start element from the resource file.
STX - Static variable in class au.id.pbw.hyfo.hyph.AlphabetBuilder
The STX is used as a start-of-word marker in patterns.
STX_CLASS - Static variable in class au.id.pbw.hyfo.hyph.AlphabetBuilder
The character class of STX is 0
STX_CLASS_INTEGER - Static variable in class au.id.pbw.hyfo.hyph.AlphabetBuilder
STX_CLASS as an Integer
Subsearch - Class in au.id.pbw.hyfo.hyph
A class representing the results of a partial search.
Subsearch(int, int[], int, int) - Constructor for class au.id.pbw.hyfo.hyph.Subsearch
Constructs a new Subsearch.
success(String, String, HyphenationTree, List<String>) - Method in class au.id.pbw.hyfo.hyph.HyphenationTreeCache
Adds the prefix, mapped to locale, to the matches map.

T

TernaryTree - Interface in au.id.pbw.hyfo.hyph
Interface describing ternary trees.
TernaryTreeDataStore - Interface in au.id.pbw.hyfo.hyph
A TernaryTreeDataStore maintains the data for an associated TernaryTree.
text - Variable in class au.id.pbw.hyfo.hyph.TextElement
The text of the element.
TextElement - Class in au.id.pbw.hyfo.hyph
Represents a text component of a pattern element.
TextElement(String) - Constructor for class au.id.pbw.hyfo.hyph.TextElement
Creates a new instance of TextElement
to_codepoint_arrays(CharSequence) - Static method in class au.id.pbw.hyfo.unicode.CodepointArrays
Returns a two-dimensional array corresponding to the CharSequence argument.
to_codepoint_arrays(CharSequence, int, int) - Static method in class au.id.pbw.hyfo.unicode.CodepointArrays
Returns a two-dimensional array corresponding to the specified range of the CharSequence argument.
to_codepoints(CharSequence) - Static method in class au.id.pbw.hyfo.unicode.CodepointArrays
Returns an array of codepoints (ints) from the given CharSequence.
to_codepoints(CharSequence, int, int) - Static method in class au.id.pbw.hyfo.unicode.CodepointArrays
Returns an array of codepoints (ints) from the given CharSequence, starting from position start, and ending at the position immediately preceding past_end.
to_fop_string() - Method in class au.id.pbw.hyfo.hyph.HyphenatedWord
Returns a fully-hyphenated string, mimicking the Fop Hyphenation.toString() method.
to_string(int[]) - Static method in class au.id.pbw.hyfo.unicode.CodepointArrays
Returns a String constructed from the given array of codepoints.
to_string(int[], int, int) - Static method in class au.id.pbw.hyfo.unicode.CodepointArrays
Returns a String constructed from the given array of codepoints, starting at offset start with number of codepoints length.
toString() - Method in class au.id.pbw.hyfo.hyph.HyphenBreak
Gets a string representation of the HyphenBreak.
TreeElement - Class in au.id.pbw.hyfo.hyph
A TreeElement is returned by a tree walker.
TreeElement(int, int[]) - Constructor for class au.id.pbw.hyfo.hyph.TreeElement
Creates a new instance of TreeElement.

U

uses_codepoints - Variable in class au.id.pbw.hyfo.hyph.Alphabet
Does this alphabet use codepoints rather than characters?

V

valueOf(String) - Static method in enum au.id.pbw.hyfo.hyph.HyphenationTreeBuilder.Element
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum au.id.pbw.hyfo.hyph.InstanceType
Returns the enum constant of this type with the specified name.
values() - Static method in enum au.id.pbw.hyfo.hyph.HyphenationTreeBuilder.Element
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum au.id.pbw.hyfo.hyph.InstanceType
Returns an array containing the constants of this enum type, in the order they're declared.
Version - Class in au.id.pbw.hyfo.version
class representing the version of HyFo
Version() - Constructor for class au.id.pbw.hyfo.version.Version
 

W

walk(int) - Method in class au.id.pbw.hyfo.hyph.BigTernaryTree.TernaryTreeWalker
Walks the tree in in-order sequence.
walk(int) - Method in class au.id.pbw.hyfo.hyph.ShortTernaryTree.TernaryTreeWalker
 
weight - Variable in class au.id.pbw.hyfo.hyph.HyphenBreak
The weight of this HyphenBreak.
weight - Variable in class au.id.pbw.hyfo.hyph.Modifier
The weight associated with the modifier.
weights - Variable in class au.id.pbw.hyfo.hyph.HyphenationTreeBuilder
Used by HyphenationTreeBuilder.process_text_element(java.lang.StringBuilder, au.id.pbw.hyfo.hyph.TextElement, au.id.pbw.hyfo.hyph.InstanceType).

A B C D E F G H I L M N O P Q R S T U V W

Copyright © 2005-2006 Peter B. West.