View Javadoc
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.lang3.text.translate;
18  
19  import java.io.IOException;
20  import java.io.Writer;
21  
22  import org.apache.commons.lang3.ArrayUtils;
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 3.0
29   * @version $Id: AggregateTranslator.java 1436770 2013-01-22 07:09:45Z ggregory $
30   */
31  public class AggregateTranslator extends CharSequenceTranslator {
32  
33      private final CharSequenceTranslator[] translators;
34  
35      /**
36       * Specify the translators to be used at creation time. 
37       *
38       * @param translators CharSequenceTranslator array to aggregate
39       */
40      public AggregateTranslator(final CharSequenceTranslator... translators) {
41          this.translators = ArrayUtils.clone(translators);
42      }
43  
44      /**
45       * The first translator to consume codepoints from the input is the 'winner'. 
46       * Execution stops with the number of consumed codepoints being returned. 
47       * {@inheritDoc}
48       */
49      @Override
50      public int translate(final CharSequence input, final int index, final Writer out) throws IOException {
51          for (final CharSequenceTranslator translator : translators) {
52              final int consumed = translator.translate(input, index, out);
53              if(consumed != 0) {
54                  return consumed;
55              }
56          }
57          return 0;
58      }
59  
60  }