View Javadoc
1   /*
2    * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4    *
5    * This code is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License version 2 only, as
7    * published by the Free Software Foundation.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle in the LICENSE file that accompanied this code.
10   *
11   * This code is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14   * version 2 for more details (a copy is included in the LICENSE file that
15   * accompanied this code).
16   *
17   * You should have received a copy of the GNU General Public License version
18   * 2 along with this work; if not, write to the Free Software Foundation,
19   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20   *
21   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22   * or visit www.oracle.com if you need additional information or have any
23   * questions.
24   */
25  
26  package sun.util.spi;
27  
28  import java.util.Calendar;
29  import java.util.Locale;
30  import java.util.TimeZone;
31  import java.util.spi.LocaleServiceProvider;
32  
33  /**
34   * An abstract class for service providers that
35   * provide instances of the
36   * {@link java.util.Calendar Calendar} class.
37   *
38   * @since        1.8
39   */
40  public abstract class CalendarProvider extends LocaleServiceProvider {
41  
42      /**
43       * Sole constructor.  (For invocation by subclass constructors, typically
44       * implicit.)
45       */
46      protected CalendarProvider() {
47      }
48  
49      /**
50       * Returns a new <code>Calendar</code> instance for the
51       * specified locale.
52       *
53       * @param zone the time zone
54       * @param locale the desired locale
55       * @exception NullPointerException if <code>locale</code> is null
56       * @exception IllegalArgumentException if <code>locale</code> isn't
57       *     one of the locales returned from
58       *     {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()
59       *     getAvailableLocales()}.
60       * @return a <code>Calendar</code> instance.
61       * @see java.util.Calendar#getInstance(java.util.Locale)
62       */
63      public abstract Calendar getInstance(TimeZone zone, Locale locale);
64  }