|
1 /** |
|
2 * Copyright (c) 2012, Ben Fortuna |
|
3 * All rights reserved. |
|
4 * |
|
5 * Redistribution and use in source and binary forms, with or without |
|
6 * modification, are permitted provided that the following conditions |
|
7 * are met: |
|
8 * |
|
9 * o Redistributions of source code must retain the above copyright |
|
10 * notice, this list of conditions and the following disclaimer. |
|
11 * |
|
12 * o Redistributions in binary form must reproduce the above copyright |
|
13 * notice, this list of conditions and the following disclaimer in the |
|
14 * documentation and/or other materials provided with the distribution. |
|
15 * |
|
16 * o Neither the name of Ben Fortuna nor the names of any other contributors |
|
17 * may be used to endorse or promote products derived from this software |
|
18 * without specific prior written permission. |
|
19 * |
|
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
|
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
|
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
|
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR |
|
24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
|
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
|
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR |
|
27 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF |
|
28 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING |
|
29 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
|
30 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
|
31 */ |
|
32 package net.fortuna.ical4j.util; |
|
33 |
|
34 import java.io.UnsupportedEncodingException; |
|
35 |
|
36 import net.fortuna.ical4j.model.parameter.Encoding; |
|
37 |
|
38 import org.apache.commons.codec.BinaryDecoder; |
|
39 import org.apache.commons.codec.StringDecoder; |
|
40 |
|
41 /** |
|
42 * Abstract base class for decoder factory implementations. |
|
43 * |
|
44 * $Id$ |
|
45 * |
|
46 * Created on 13/05/2006 |
|
47 * |
|
48 * @author Ben Fortuna |
|
49 */ |
|
50 public abstract class DecoderFactory { |
|
51 |
|
52 /** |
|
53 * The system property used to specify an alternate |
|
54 * <code>DecoderFactory</code> implementation. |
|
55 */ |
|
56 public static final String KEY_FACTORY_CLASS = "net.fortuna.ical4j.factory.decoder"; |
|
57 |
|
58 private static DecoderFactory instance; |
|
59 static { |
|
60 try { |
|
61 final Class factoryClass = Class.forName(Configurator.getProperty(KEY_FACTORY_CLASS)); |
|
62 instance = (DecoderFactory) factoryClass.newInstance(); |
|
63 } |
|
64 catch (Exception e) { |
|
65 instance = new DefaultDecoderFactory(); |
|
66 } |
|
67 } |
|
68 |
|
69 /** |
|
70 * @return Returns the instance. |
|
71 */ |
|
72 public static final DecoderFactory getInstance() { |
|
73 return instance; |
|
74 } |
|
75 |
|
76 /** |
|
77 * Returns a new {@link BinaryDecoder} for the specified encoding. |
|
78 * @param encoding an encoding type |
|
79 * @return a {@link BinaryDecoder} instance |
|
80 * @throws UnsupportedEncodingException where an encoder supporting the |
|
81 * specified encoding is not available. |
|
82 */ |
|
83 public abstract BinaryDecoder createBinaryDecoder(Encoding encoding) |
|
84 throws UnsupportedEncodingException; |
|
85 |
|
86 /** |
|
87 * Returns a new {@link StringDecoder} for the specified encoding. |
|
88 * @param encoding an encoding type |
|
89 * @return a {@link StringDecoder} instance |
|
90 * @throws UnsupportedEncodingException where an encoder supporting the |
|
91 * specified encoding is not available. |
|
92 */ |
|
93 public abstract StringDecoder createStringDecoder(Encoding encoding) |
|
94 throws UnsupportedEncodingException; |
|
95 } |