blob: 6263b5534a3927057355a7996b7d5afaa7211f34 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* $Id$ */
package org.apache.fop.hyphenation;
import java.util.ArrayList;
/**
* This interface is used to connect the XML pattern file parser to
* the hyphenation tree.
*
* @author Carlos Villegas <cav@uniscope.co.jp>
*/
public interface PatternConsumer {
/**
* Add a character class.
* A character class defines characters that are considered
* equivalent for the purpose of hyphenation (e.g. "aA"). It
* usually means to ignore case.
* @param chargroup character group
*/
void addClass(String chargroup);
/**
* Add a hyphenation exception. An exception replaces the
* result obtained by the algorithm for cases for which this
* fails or the user wants to provide his own hyphenation.
* A hyphenatedword is a vector of alternating String's and
* {@link Hyphen Hyphen} instances
*/
void addException(String word, ArrayList hyphenatedword);
/**
* Add hyphenation patterns.
* @param pattern the pattern
* @param values interletter values expressed as a string of
* digit characters.
*/
void addPattern(String pattern, String values);
}
|
