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