    001    /*
    002     * Licensed to the Apache Software Foundation (ASF) under one or more
    003     * contributor license agreements.  See the NOTICE file distributed with
    004     * this work for additional information regarding copyright ownership.
    005     * The ASF licenses this file to You under the Apache License, Version 2.0
    006     * (the "License"); you may not use this file except in compliance with
    007     * the License.  You may obtain a copy of the License at
    008     *
    009     *      http://www.apache.org/licenses/LICENSE-2.0
    010     *
    011     * Unless required by applicable law or agreed to in writing, software
    012     * distributed under the License is distributed on an "AS IS" BASIS,
    013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014     * See the License for the specific language governing permissions and
    015     * limitations under the License.
    016     */
    017    package org.apache.commons.lang3.text.translate;
    018
    019    import java.io.IOException;
    020    import java.io.Writer;
    021
    022    import org.apache.commons.lang3.ArrayUtils;
    023
    024    /**
    025     * Executes a sequence of translators one after the other. Execution ends whenever
    026     * the first translator consumes codepoints from the input.
    027     *
    028     * @author Apache Software Foundation
    029     * @since 3.0
    030     * @version $Id: AggregateTranslator.java 967237 2010-07-23 20:08:57Z mbenson $
    031     */
    032    public class AggregateTranslator extends CharSequenceTranslator {
    033
    034        private final CharSequenceTranslator[] translators;
    035
    036        /**
    037         * Specify the translators to be used at creation time.
    038         *
    039         * @param translators CharSequenceTranslator array to aggregate
    040         */
    041        public AggregateTranslator(CharSequenceTranslator... translators) {
    042            this.translators = ArrayUtils.clone(translators);
    043        }
    044
    045        /**
    046         * The first translator to consume codepoints from the input is the 'winner'.
    047         * Execution stops with the number of consumed codepoints being returned.
    048         * {@inheritDoc}
    049         */
    050        @Override
    051        public int translate(CharSequence input, int index, Writer out) throws IOException {
    052            for (CharSequenceTranslator translator : translators) {
    053                int consumed = translator.translate(input, index, out);
    054                if(consumed != 0) {
    055                    return consumed;
    056                }
    057            }
    058            return 0;
    059        }
    060
    061    }