AbstractContentFactory.java

/**
 * 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.model;

import java.util.HashMap;
import java.util.Map;

import net.fortuna.ical4j.util.CompatibilityHints;

/**
 * $Id$
 *
 * Created on 28/01/2007
 *
 * Abstract implementation of a content factory.
 * @author Ben Fortuna
 */
public abstract class AbstractContentFactory {

    /**
     * Map of delegate factories.
     */
    private final Map defaultFactories;

    private final Map extendedFactories;

    /**
     * Default constructor.
     */
    public AbstractContentFactory() {
        defaultFactories = new HashMap();
        extendedFactories = new HashMap();
    }

    /**
     * Register a standard content factory.
     */
    protected final void registerDefaultFactory(String key, Object factory) {
        defaultFactories.put(key, factory);
    }

    /**
     * Register a non-standard content factory.
     */
    protected final void registerExtendedFactory(String key, Object factory) {
        extendedFactories.put(key, factory);
    }

    /**
     * @param key a factory key
     * @return a factory associated with the specified key, giving preference to
     * standard factories
     */
    protected final Object getFactory(String key) {
        Object factory = defaultFactories.get(key);
        if (factory == null) {
            factory = extendedFactories.get(key);
        }
        return factory;
    }
    
    /**
     * @return true if non-standard names are allowed, otherwise false
     */
    protected boolean allowIllegalNames() {
        return CompatibilityHints
                .isHintEnabled(CompatibilityHints.KEY_RELAXED_PARSING);
    }
}