1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.text.translate;
18
19 import java.io.IOException;
20 import java.io.Writer;
21 import java.util.ArrayList;
22 import java.util.List;
23
24 /**
25 * Executes a sequence of translators one after the other. Execution ends whenever
26 * the first translator consumes codepoints from the input.
27 *
28 * @since 1.0
29 */
30 public class AggregateTranslator extends CharSequenceTranslator {
31
32 private final List<CharSequenceTranslator> translators = new ArrayList<>();
33
34 /**
35 * Specify the translators to be used at creation time.
36 *
37 * @param translators CharSequenceTranslator array to aggregate
38 */
39 public AggregateTranslator(final CharSequenceTranslator... translators) {
40 if (translators != null) {
41 for (CharSequenceTranslator translator : translators) {
42 if (translator != null) {
43 this.translators.add(translator);
44 }
45 }
46 }
47 }
48
49 /**
50 * The first translator to consume codepoints from the input is the 'winner'.
51 * Execution stops with the number of consumed codepoints being returned.
52 * {@inheritDoc}
53 */
54 @Override
55 public int translate(final CharSequence input, final int index, final Writer out) throws IOException {
56 for (final CharSequenceTranslator translator : translators) {
57 final int consumed = translator.translate(input, index, out);
58 if(consumed != 0) {
59 return consumed;
60 }
61 }
62 return 0;
63 }
64
65 }