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.model;
michael@0: 
michael@0: /**
michael@0:  * $Id$
michael@0:  *
michael@0:  * Created on 18/09/2005
michael@0:  *
michael@0:  * Implementors provide a list of timezone definitions applicable for use
michael@0:  * with iCalendar objects.
michael@0:  * @author Ben Fortuna
michael@0:  */
michael@0: public interface TimeZoneRegistry {
michael@0: 
michael@0:     /**
michael@0:      * Registers a new timezone for use with iCalendar objects. If a timezone
michael@0:      * with the same identifier is already registered this timezone will take
michael@0:      * precedence.
michael@0:      * @param timezone a timezone to be registered for use with iCalendar
michael@0:      * objects
michael@0:      */
michael@0:     void register(final TimeZone timezone);
michael@0:     
michael@0:     /**
michael@0:      * Registers a new timezone for use with iCalendar objects. If a timezone
michael@0:      * with the same identifier is already registered this timezone will take
michael@0:      * precedence.
michael@0:      * @param timezone a timezone to be registered for use with iCalendar
michael@0:      * objects
michael@0:      * @param update attempt to update the definition from any specified TZURL
michael@0:      * property if true
michael@0:      */
michael@0:     void register(final TimeZone timezone, boolean update);
michael@0:     
michael@0:     /**
michael@0:      * Clears all registered timezones.
michael@0:      */
michael@0:     void clear();
michael@0:     
michael@0:     /**
michael@0:      * Returns a timezone with the specified identifier.
michael@0:      * @param id a timezone identifier
michael@0:      * @return a timezone matching the specified identifier. If no timezone
michael@0:      * is registered with the specified identifier null is returned.
michael@0:      */
michael@0:     TimeZone getTimeZone(final String id);
michael@0: }