001/* DateFormatProvider.java -- Providers of localized instances 002 Copyright (C) 2007 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038package java.text.spi; 039 040import java.text.DateFormat; 041 042import java.util.Locale; 043 044import java.util.spi.LocaleServiceProvider; 045 046/** 047 * A {@link DateFormatProvider} provides localized 048 * instances of {@link java.text.DateFormat}. 049 * 050 * @author Andrew John Hughes (gnu_andrew@member.fsf.org) 051 * @since 1.6 052 */ 053public abstract class DateFormatProvider 054 extends LocaleServiceProvider 055{ 056 057 /** 058 * Constructs a new {@link DateFormatProvider}. 059 * Provided for implicit invocation by subclasses. 060 */ 061 protected DateFormatProvider() 062 { 063 } 064 065 /** 066 * Returns a {@link java.text.DateFormat} instance 067 * for formatting dates with the given style in the specified 068 * {@link java.util.Locale}. 069 * 070 * @param style the formatting style; one of {@link DateFormat#SHORT}, 071 * {@link DateFormat#MEDIUM}, {@link DateFormat#LONG} 072 * or {@link DateFormat#FULL}. 073 * @param locale the desired locale. 074 * @return the localized instance for formatting dates. 075 * @throws NullPointerException if the locale is null. 076 * @throws IllegalArgumentException if the style is invalid or 077 * the locale is not one 078 * returned by 079 * {@link getAvailableLocales()} 080 * @see java.text.DateFormat#getDateInstance(int,java.util.Locale) 081 */ 082 public abstract DateFormat getDateInstance(int style, 083 Locale locale); 084 085 /** 086 * Returns a {@link java.text.DateFormat} instance 087 * for formatting dates and times with the given style in the 088 * specified {@link java.util.Locale}. 089 * 090 * @param dateStyle the date formatting style; one of 091 * {@link DateFormat#SHORT}, {@link DateFormat#MEDIUM}, 092 * {@link DateFormat#LONG} or {@link DateFormat#FULL}. 093 * @param timeStyle the time formatting style; one of 094 * {@link DateFormat#SHORT}, {@link DateFormat#MEDIUM}, 095 * {@link DateFormat#LONG} or {@link DateFormat#FULL}. 096 * @param locale the desired locale. 097 * @return the localized instance for formatting dates. 098 * @throws NullPointerException if the locale is null. 099 * @throws IllegalArgumentException if either style is invalid or 100 * the locale is not one 101 * returned by 102 * {@link getAvailableLocales()} 103 * @see java.text.DateFormat#getDateInstance(java.util.Locale) 104 */ 105 public abstract DateFormat getDateTimeInstance(int dateStyle, 106 int timeStyle, 107 Locale locale); 108 109 /** 110 * Returns a {@link java.text.DateFormat} instance 111 * for formatting times with the given style in the specified 112 * {@link java.util.Locale}. 113 * 114 * @param style the formatting style; one of {@link DateFormat#SHORT}, 115 * {@link DateFormat#MEDIUM}, {@link DateFormat#LONG} 116 * or {@link DateFormat#FULL}. 117 * @param locale the desired locale. 118 * @return the localized instance for formatting times. 119 * @throws NullPointerException if the locale is null. 120 * @throws IllegalArgumentException if the style is invalid or 121 * the locale is not one 122 * returned by 123 * {@link getAvailableLocales()} 124 * @see java.text.DateFormat#getTimeInstance(int,java.util.Locale) 125 */ 126 public abstract DateFormat getTimeInstance(int style, 127 Locale locale); 128 129}