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.lang.text;
018    
019    import java.text.FieldPosition;
020    import java.text.Format;
021    import java.text.ParseException;
022    import java.text.ParsePosition;
023    
024    /**
025     * Formats using one formatter and parses using a different formatter. An
026     * example of use for this would be a webapp where data is taken in one way and
027     * stored in a database another way.
028     * 
029     * @author Apache Software Foundation
030     * @author Archimedes Trajano
031     * @version $Id: CompositeFormat.java 905636 2010-02-02 14:03:32Z niallp $
032     */
033    public class CompositeFormat extends Format {
034    
035        /**
036         * Required for serialization support.
037         * 
038         * @see java.io.Serializable
039         */
040        private static final long serialVersionUID = -4329119827877627683L;
041    
042        /** The parser to use. */
043        private final Format parser;
044        /** The formatter to use. */
045        private final Format formatter;
046    
047        /**
048         * Create a format that points its parseObject method to one implementation
049         * and its format method to another.
050         * 
051         * @param parser implementation
052         * @param formatter implementation
053         */
054        public CompositeFormat(Format parser, Format formatter) {
055            this.parser = parser;
056            this.formatter = formatter;
057        }
058    
059        /**
060         * Uses the formatter Format instance.
061         * 
062         * @param obj the object to format
063         * @param toAppendTo the {@link StringBuffer} to append to
064         * @param pos the FieldPosition to use (or ignore).
065         * @return <code>toAppendTo</code>
066         * @see Format#format(Object, StringBuffer, FieldPosition)
067         */
068        public StringBuffer format(Object obj, StringBuffer toAppendTo,
069                FieldPosition pos) {
070            return formatter.format(obj, toAppendTo, pos);
071        }
072    
073        /**
074         * Uses the parser Format instance.
075         * 
076         * @param source the String source
077         * @param pos the ParsePosition containing the position to parse from, will
078         *            be updated according to parsing success (index) or failure
079         *            (error index)
080         * @return the parsed Object
081         * @see Format#parseObject(String, ParsePosition)
082         */
083        public Object parseObject(String source, ParsePosition pos) {
084            return parser.parseObject(source, pos);
085        }
086    
087        /**
088         * Provides access to the parser Format implementation.
089         * 
090         * @return parser Format implementation
091         */
092        public Format getParser() {
093            return this.parser;
094        }
095    
096        /**
097         * Provides access to the parser Format implementation.
098         * 
099         * @return formatter Format implementation
100         */
101        public Format getFormatter() {
102            return this.formatter;
103        }
104    
105        /**
106         * Utility method to parse and then reformat a String.
107         * 
108         * @param input String to reformat
109         * @return A reformatted String
110         * @throws ParseException thrown by parseObject(String) call
111         */
112        public String reformat(String input) throws ParseException {
113            return format(parseObject(input));
114        }
115    
116    }