1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/net/fortuna/ical4j/util/EncoderFactory.java Tue Feb 10 18:12:00 2015 +0100
1.3 @@ -0,0 +1,95 @@
1.4 +/**
1.5 + * Copyright (c) 2012, Ben Fortuna
1.6 + * All rights reserved.
1.7 + *
1.8 + * Redistribution and use in source and binary forms, with or without
1.9 + * modification, are permitted provided that the following conditions
1.10 + * are met:
1.11 + *
1.12 + * o Redistributions of source code must retain the above copyright
1.13 + * notice, this list of conditions and the following disclaimer.
1.14 + *
1.15 + * o Redistributions in binary form must reproduce the above copyright
1.16 + * notice, this list of conditions and the following disclaimer in the
1.17 + * documentation and/or other materials provided with the distribution.
1.18 + *
1.19 + * o Neither the name of Ben Fortuna nor the names of any other contributors
1.20 + * may be used to endorse or promote products derived from this software
1.21 + * without specific prior written permission.
1.22 + *
1.23 + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1.24 + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1.25 + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
1.26 + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
1.27 + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
1.28 + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
1.29 + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
1.30 + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
1.31 + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
1.32 + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
1.33 + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1.34 + */
1.35 +package net.fortuna.ical4j.util;
1.36 +
1.37 +import java.io.UnsupportedEncodingException;
1.38 +
1.39 +import net.fortuna.ical4j.model.parameter.Encoding;
1.40 +
1.41 +import org.apache.commons.codec.BinaryEncoder;
1.42 +import org.apache.commons.codec.StringEncoder;
1.43 +
1.44 +/**
1.45 + * Abstract base class for encoder factory implementations.
1.46 + *
1.47 + * $Id$
1.48 + *
1.49 + * Created on 13/05/2006
1.50 + *
1.51 + * @author Ben Fortuna
1.52 + */
1.53 +public abstract class EncoderFactory {
1.54 +
1.55 + /**
1.56 + * The system property used to specify an alternate
1.57 + * <code>EncoderFactory</code> implementation.
1.58 + */
1.59 + public static final String KEY_FACTORY_CLASS = "net.fortuna.ical4j.factory.encoder";
1.60 +
1.61 + private static EncoderFactory instance;
1.62 + static {
1.63 + try {
1.64 + final Class factoryClass = Class.forName(Configurator.getProperty(KEY_FACTORY_CLASS));
1.65 + instance = (EncoderFactory) factoryClass.newInstance();
1.66 + }
1.67 + catch (Exception e) {
1.68 + instance = new DefaultEncoderFactory();
1.69 + }
1.70 + }
1.71 +
1.72 + /**
1.73 + * @return Returns the instance.
1.74 + */
1.75 + public static final EncoderFactory getInstance() {
1.76 + return instance;
1.77 + }
1.78 +
1.79 + /**
1.80 + * Returns a new {@link BinaryEncoder} for the specified encoding.
1.81 + * @param encoding an encoding type
1.82 + * @return a {@link BinaryEncoder} instance
1.83 + * @throws UnsupportedEncodingException where an encoder supporting the
1.84 + * specified encoding is not available.
1.85 + */
1.86 + public abstract BinaryEncoder createBinaryEncoder(Encoding encoding)
1.87 + throws UnsupportedEncodingException;
1.88 +
1.89 + /**
1.90 + * Returns a new {@link StringEncoder} for the specified encoding.
1.91 + * @param encoding an encoding type
1.92 + * @return a {@link StringEncoder} instance
1.93 + * @throws UnsupportedEncodingException where an encoder supporting the
1.94 + * specified encoding is not available.
1.95 + */
1.96 + public abstract StringEncoder createStringEncoder(Encoding encoding)
1.97 + throws UnsupportedEncodingException;
1.98 +}
