src/net/fortuna/ical4j/model/TimeZoneRegistry.java@45d57ecba757 (annotated)
src/net/fortuna/ical4j/model/TimeZoneRegistry.java
Tue, 10 Feb 2015 19:58:00 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Tue, 10 Feb 2015 19:58:00 +0100
- changeset 4
- 45d57ecba757
- permissions
- -rw-r--r--
Upgrade the upgraded ical4j component to use org.apache.commons.lang3.
| michael@0 | 1 | /** |
| michael@0 | 2 | * Copyright (c) 2012, Ben Fortuna |
| michael@0 | 3 | * All rights reserved. |
| michael@0 | 4 | * |
| michael@0 | 5 | * Redistribution and use in source and binary forms, with or without |
| michael@0 | 6 | * modification, are permitted provided that the following conditions |
| michael@0 | 7 | * are met: |
| michael@0 | 8 | * |
| michael@0 | 9 | * o Redistributions of source code must retain the above copyright |
| michael@0 | 10 | * notice, this list of conditions and the following disclaimer. |
| michael@0 | 11 | * |
| michael@0 | 12 | * o Redistributions in binary form must reproduce the above copyright |
| michael@0 | 13 | * notice, this list of conditions and the following disclaimer in the |
| michael@0 | 14 | * documentation and/or other materials provided with the distribution. |
| michael@0 | 15 | * |
| michael@0 | 16 | * o Neither the name of Ben Fortuna nor the names of any other contributors |
| michael@0 | 17 | * may be used to endorse or promote products derived from this software |
| michael@0 | 18 | * without specific prior written permission. |
| michael@0 | 19 | * |
| michael@0 | 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| michael@0 | 21 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| michael@0 | 22 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| michael@0 | 23 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR |
| michael@0 | 24 | * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
| michael@0 | 25 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
| michael@0 | 26 | * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR |
| michael@0 | 27 | * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF |
| michael@0 | 28 | * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING |
| michael@0 | 29 | * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
| michael@0 | 30 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| michael@0 | 31 | */ |
| michael@0 | 32 | package net.fortuna.ical4j.model; |
| michael@0 | 33 | |
| michael@0 | 34 | /** |
| michael@0 | 35 | * $Id$ |
| michael@0 | 36 | * |
| michael@0 | 37 | * Created on 18/09/2005 |
| michael@0 | 38 | * |
| michael@0 | 39 | * Implementors provide a list of timezone definitions applicable for use |
| michael@0 | 40 | * with iCalendar objects. |
| michael@0 | 41 | * @author Ben Fortuna |
| michael@0 | 42 | */ |
| michael@0 | 43 | public interface TimeZoneRegistry { |
| michael@0 | 44 | |
| michael@0 | 45 | /** |
| michael@0 | 46 | * Registers a new timezone for use with iCalendar objects. If a timezone |
| michael@0 | 47 | * with the same identifier is already registered this timezone will take |
| michael@0 | 48 | * precedence. |
| michael@0 | 49 | * @param timezone a timezone to be registered for use with iCalendar |
| michael@0 | 50 | * objects |
| michael@0 | 51 | */ |
| michael@0 | 52 | void register(final TimeZone timezone); |
| michael@0 | 53 | |
| michael@0 | 54 | /** |
| michael@0 | 55 | * Registers a new timezone for use with iCalendar objects. If a timezone |
| michael@0 | 56 | * with the same identifier is already registered this timezone will take |
| michael@0 | 57 | * precedence. |
| michael@0 | 58 | * @param timezone a timezone to be registered for use with iCalendar |
| michael@0 | 59 | * objects |
| michael@0 | 60 | * @param update attempt to update the definition from any specified TZURL |
| michael@0 | 61 | * property if true |
| michael@0 | 62 | */ |
| michael@0 | 63 | void register(final TimeZone timezone, boolean update); |
| michael@0 | 64 | |
| michael@0 | 65 | /** |
| michael@0 | 66 | * Clears all registered timezones. |
| michael@0 | 67 | */ |
| michael@0 | 68 | void clear(); |
| michael@0 | 69 | |
| michael@0 | 70 | /** |
| michael@0 | 71 | * Returns a timezone with the specified identifier. |
| michael@0 | 72 | * @param id a timezone identifier |
| michael@0 | 73 | * @return a timezone matching the specified identifier. If no timezone |
| michael@0 | 74 | * is registered with the specified identifier null is returned. |
| michael@0 | 75 | */ |
| michael@0 | 76 | TimeZone getTimeZone(final String id); |
| michael@0 | 77 | } |
