src/net/fortuna/ical4j/model/TimeZoneRegistry.java

changeset 4
45d57ecba757
equal deleted inserted replaced
-1:000000000000 0:10ac3ac7a15b
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.model;
33
34 /**
35 * $Id$
36 *
37 * Created on 18/09/2005
38 *
39 * Implementors provide a list of timezone definitions applicable for use
40 * with iCalendar objects.
41 * @author Ben Fortuna
42 */
43 public interface TimeZoneRegistry {
44
45 /**
46 * Registers a new timezone for use with iCalendar objects. If a timezone
47 * with the same identifier is already registered this timezone will take
48 * precedence.
49 * @param timezone a timezone to be registered for use with iCalendar
50 * objects
51 */
52 void register(final TimeZone timezone);
53
54 /**
55 * Registers a new timezone for use with iCalendar objects. If a timezone
56 * with the same identifier is already registered this timezone will take
57 * precedence.
58 * @param timezone a timezone to be registered for use with iCalendar
59 * objects
60 * @param update attempt to update the definition from any specified TZURL
61 * property if true
62 */
63 void register(final TimeZone timezone, boolean update);
64
65 /**
66 * Clears all registered timezones.
67 */
68 void clear();
69
70 /**
71 * Returns a timezone with the specified identifier.
72 * @param id a timezone identifier
73 * @return a timezone matching the specified identifier. If no timezone
74 * is registered with the specified identifier null is returned.
75 */
76 TimeZone getTimeZone(final String id);
77 }

mercurial