michael@0: /**
michael@0:  * Copyright (c) 2012, Ben Fortuna
michael@0:  * All rights reserved.
michael@0:  *
michael@0:  * Redistribution and use in source and binary forms, with or without
michael@0:  * modification, are permitted provided that the following conditions
michael@0:  * are met:
michael@0:  *
michael@0:  *  o Redistributions of source code must retain the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer.
michael@0:  *
michael@0:  *  o Redistributions in binary form must reproduce the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer in the
michael@0:  * documentation and/or other materials provided with the distribution.
michael@0:  *
michael@0:  *  o Neither the name of Ben Fortuna nor the names of any other contributors
michael@0:  * may be used to endorse or promote products derived from this software
michael@0:  * without specific prior written permission.
michael@0:  *
michael@0:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0:  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0:  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
michael@0:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
michael@0:  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
michael@0:  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
michael@0:  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
michael@0:  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
michael@0:  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
michael@0:  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0:  */
michael@0: package net.fortuna.ical4j.util;
michael@0: 
michael@0: import java.io.UnsupportedEncodingException;
michael@0: 
michael@0: import net.fortuna.ical4j.model.parameter.Encoding;
michael@0: 
michael@0: import org.apache.commons.codec.BinaryDecoder;
michael@0: import org.apache.commons.codec.StringDecoder;
michael@0: 
michael@0: /**
michael@0:  * Abstract base class for decoder factory implementations.
michael@0:  * 
michael@0:  * $Id$
michael@0:  *
michael@0:  * Created on 13/05/2006
michael@0:  *
michael@0:  * @author Ben Fortuna
michael@0:  */
michael@0: public abstract class DecoderFactory {
michael@0:     
michael@0:     /**
michael@0:      * The system property used to specify an alternate
michael@0:      * <code>DecoderFactory</code> implementation.
michael@0:      */
michael@0:     public static final String KEY_FACTORY_CLASS = "net.fortuna.ical4j.factory.decoder";
michael@0: 
michael@0:     private static DecoderFactory instance;
michael@0:     static {
michael@0:         try {
michael@0:             final Class factoryClass = Class.forName(Configurator.getProperty(KEY_FACTORY_CLASS));
michael@0:             instance = (DecoderFactory) factoryClass.newInstance();
michael@0:         }
michael@0:         catch (Exception e) {
michael@0:             instance = new DefaultDecoderFactory();
michael@0:         }
michael@0:     }
michael@0:     
michael@0:     /**
michael@0:      * @return Returns the instance.
michael@0:      */
michael@0:     public static final DecoderFactory getInstance() {
michael@0:         return instance;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Returns a new {@link BinaryDecoder} for the specified encoding.
michael@0:      * @param encoding an encoding type
michael@0:      * @return a {@link BinaryDecoder} instance
michael@0:      * @throws UnsupportedEncodingException where an encoder supporting the
michael@0:      * specified encoding is not available.
michael@0:      */
michael@0:     public abstract BinaryDecoder createBinaryDecoder(Encoding encoding)
michael@0:         throws UnsupportedEncodingException;
michael@0:     
michael@0:     /**
michael@0:      * Returns a new {@link StringDecoder} for the specified encoding.
michael@0:      * @param encoding an encoding type
michael@0:      * @return a {@link StringDecoder} instance
michael@0:      * @throws UnsupportedEncodingException where an encoder supporting the
michael@0:      * specified encoding is not available.
michael@0:      */
michael@0:     public abstract StringDecoder createStringDecoder(Encoding encoding)
michael@0:         throws UnsupportedEncodingException;
michael@0: }