1 /*
   2  * Copyright (c) 2012, 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 java.util.spi;
  27 
  28 import java.util.Calendar;
  29 import java.util.Locale;
  30 
  31 /**
  32  * An abstract class for service providers that provide locale-dependent {@link
  33  * Calendar} parameters.
  34  *
  35  * @author Masayoshi Okutsu
  36  * @since 1.8
  37  * @see CalendarNameProvider
  38  */
  39 public abstract class CalendarDataProvider extends LocaleServiceProvider {
  40 
  41     /**
  42      * Sole constructor. (For invocation by subclass constructors, typically
  43      * implicit.)
  44      */
  45     protected CalendarDataProvider() {
  46     }
  47 
  48     /**
  49      * Returns the first day of a week in the given {@code locale}. This
  50      * information is required by {@link Calendar} to support operations on the
  51      * week-related calendar fields.
  52      *
  53      * @param locale
  54      *        the desired locale
  55      * @return the first day of a week; one of {@link Calendar#SUNDAY} ..
  56      *         {@link Calendar#SATURDAY},
  57      *         or 0 if the value isn't available for the {@code locale}
  58      * @throws NullPointerException
  59      *         if {@code locale} is {@code null}.
  60      * @see java.util.Calendar#getFirstDayOfWeek()
  61      * @see <a href="../Calendar.html#first_week">First Week</a>
  62      */
  63     public abstract int getFirstDayOfWeek(Locale locale);
  64 
  65     /**
  66      * Returns the minimal number of days required in the first week of a
  67      * year. This information is required by {@link Calendar} to determine the
  68      * first week of a year. Refer to the description of <a
  69      * href="../Calendar.html#first_week"> how {@code Calendar} determines
  70      * the first week</a>.
  71      *
  72      * @param locale
  73      *        the desired locale
  74      * @return the minimal number of days of the first week,
  75      *         or 0 if the value isn't available for the {@code locale}
  76      * @throws NullPointerException
  77      *         if {@code locale} is {@code null}.
  78      * @see java.util.Calendar#getMinimalDaysInFirstWeek()
  79      */
  80     public abstract int getMinimalDaysInFirstWeek(Locale locale);
  81 }