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.util.Map;
michael@0: 
michael@0: import edu.emory.mathcs.backport.java.util.concurrent.ConcurrentHashMap;
michael@0: 
michael@0: /**
michael@0:  * $Id$
michael@0:  * 
michael@0:  * Created on 9/03/2006
michael@0:  * 
michael@0:  * A set of keys used to enable compatibility features.
michael@0:  * 
michael@0:  * @author Ben Fortuna
michael@0:  */
michael@0: public final class CompatibilityHints {
michael@0: 
michael@0:     /**
michael@0:      * A system property key to enable relaxed unfolding. Relaxed unfolding is enabled by setting this system property
michael@0:      * to "true".
michael@0:      */
michael@0:     public static final String KEY_RELAXED_UNFOLDING = "ical4j.unfolding.relaxed";
michael@0: 
michael@0:     /**
michael@0:      * A system property key to enable relaxed parsing. Relaxed parsing is enabled by setting this system property to
michael@0:      * "true".
michael@0:      */
michael@0:     public static final String KEY_RELAXED_PARSING = "ical4j.parsing.relaxed";
michael@0: 
michael@0:     /**
michael@0:      * A system property key to enable relaxed validation. Relaxed validation disables validation of certain conformance
michael@0:      * rules that many iCalendar implementations do not conform to. Relaxed validation is enabled by setting this system
michael@0:      * property to "true".
michael@0:      */
michael@0:     public static final String KEY_RELAXED_VALIDATION = "ical4j.validation.relaxed";
michael@0: 
michael@0:     /**
michael@0:      * A system property key used to enable compatibility with Outlook/Exchange-generated iCalendar files. Outlook
michael@0:      * compatibility is enabled by setting this system property to "true".
michael@0:      */
michael@0:     public static final String KEY_OUTLOOK_COMPATIBILITY = "ical4j.compatibility.outlook";
michael@0: 
michael@0:     /**
michael@0:      * A system property key used to enable compatibility with Lotus Notes-generated iCalendar files. Notes
michael@0:      * compatibility is enabled by setting this system property to "true".
michael@0:      */
michael@0:     public static final String KEY_NOTES_COMPATIBILITY = "ical4j.compatibility.notes";
michael@3:     
michael@3:     /**
michael@3:      * Support for vCard features that are not necessarily compatible with the iCalendar standard.
michael@3:      */
michael@3:     public static final String KEY_VCARD_COMPATIBILITY = "ical4j.compatibility.vcard";
michael@0: 
michael@0:     private static final Map HINTS = new ConcurrentHashMap();
michael@0:     // preload known hints from the configurator
michael@0:     static {
michael@0:         setHintEnabled(KEY_RELAXED_UNFOLDING, "true".equals(Configurator.getProperty(KEY_RELAXED_UNFOLDING)));
michael@0:         setHintEnabled(KEY_RELAXED_PARSING, "true".equals(Configurator.getProperty(KEY_RELAXED_PARSING)));
michael@0:         setHintEnabled(KEY_RELAXED_VALIDATION, "true".equals(Configurator.getProperty(KEY_RELAXED_VALIDATION)));
michael@0:         setHintEnabled(KEY_OUTLOOK_COMPATIBILITY, "true".equals(Configurator.getProperty(KEY_OUTLOOK_COMPATIBILITY)));
michael@0:         setHintEnabled(KEY_NOTES_COMPATIBILITY, "true".equals(Configurator.getProperty(KEY_NOTES_COMPATIBILITY)));
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Constructor made private to enforce static nature.
michael@0:      */
michael@0:     private CompatibilityHints() {
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param key
michael@0:      *            a compatibility hint key
michael@0:      * @param enabled
michael@0:      *            indicates whether to enable or disable the compatibility hint
michael@0:      */
michael@0:     public static void setHintEnabled(final String key, final boolean enabled) {
michael@0:         HINTS.put(key, Boolean.valueOf(enabled));
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param key
michael@0:      *            a compatibility hint key
michael@0:      */
michael@0:     public static void clearHintEnabled(final String key) {
michael@0:         HINTS.remove(key);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param key
michael@0:      *            a compatibility hint key
michael@0:      * @return true if the specified compatibility hint is enabled, otherwise false
michael@0:      */
michael@0:     public static boolean isHintEnabled(final String key) {
michael@0:         if (HINTS.get(key) != null) {
michael@0:             return ((Boolean) HINTS.get(key)).booleanValue();
michael@0:         }
michael@0:         return "true".equals(Configurator.getProperty(key));
michael@0:     }
michael@0: }