| Frames | No Frames |
1: /* DateFormatProvider.java -- Providers of localized instances 2: Copyright (C) 2007 Free Software Foundation, Inc. 3: 4: This file is part of GNU Classpath. 5: 6: GNU Classpath is free software; you can redistribute it and/or modify 7: it under the terms of the GNU General Public License as published by 8: the Free Software Foundation; either version 2, or (at your option) 9: any later version. 10: 11: GNU Classpath is distributed in the hope that it will be useful, but 12: WITHOUT ANY WARRANTY; without even the implied warranty of 13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14: General Public License for more details. 15: 16: You should have received a copy of the GNU General Public License 17: along with GNU Classpath; see the file COPYING. If not, write to the 18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 19: 02110-1301 USA. 20: 21: Linking this library statically or dynamically with other modules is 22: making a combined work based on this library. Thus, the terms and 23: conditions of the GNU General Public License cover the whole 24: combination. 25: 26: As a special exception, the copyright holders of this library give you 27: permission to link this library with independent modules to produce an 28: executable, regardless of the license terms of these independent 29: modules, and to copy and distribute the resulting executable under 30: terms of your choice, provided that you also meet, for each linked 31: independent module, the terms and conditions of the license of that 32: module. An independent module is a module which is not derived from 33: or based on this library. If you modify this library, you may extend 34: this exception to your version of the library, but you are not 35: obligated to do so. If you do not wish to do so, delete this 36: exception statement from your version. */ 37: 38: package java.text.spi; 39: 40: import java.text.DateFormat; 41: 42: import java.util.Locale; 43: 44: import java.util.spi.LocaleServiceProvider; 45: 46: /** 47: * A {@link DateFormatProvider} provides localized 48: * instances of {@link java.text.DateFormat}. 49: * 50: * @author Andrew John Hughes (gnu_andrew@member.fsf.org) 51: * @since 1.6 52: */ 53: public abstract class DateFormatProvider 54: extends LocaleServiceProvider 55: { 56: 57: /** 58: * Constructs a new {@link DateFormatProvider}. 59: * Provided for implicit invocation by subclasses. 60: */ 61: protected DateFormatProvider() 62: { 63: } 64: 65: /** 66: * Returns a {@link java.text.DateFormat} instance 67: * for formatting dates with the given style in the specified 68: * {@link java.util.Locale}. 69: * 70: * @param style the formatting style; one of {@link DateFormat#SHORT}, 71: * {@link DateFormat#MEDIUM}, {@link DateFormat#LONG} 72: * or {@link DateFormat#FULL}. 73: * @param locale the desired locale. 74: * @return the localized instance for formatting dates. 75: * @throws NullPointerException if the locale is null. 76: * @throws IllegalArgumentException if the style is invalid or 77: * the locale is not one 78: * returned by 79: * {@link getAvailableLocales()} 80: * @see java.text.DateFormat#getDateInstance(int,java.util.Locale) 81: */ 82: public abstract DateFormat getDateInstance(int style, 83: Locale locale); 84: 85: /** 86: * Returns a {@link java.text.DateFormat} instance 87: * for formatting dates and times with the given style in the 88: * specified {@link java.util.Locale}. 89: * 90: * @param dateStyle the date formatting style; one of 91: * {@link DateFormat#SHORT}, {@link DateFormat#MEDIUM}, 92: * {@link DateFormat#LONG} or {@link DateFormat#FULL}. 93: * @param timeStyle the time formatting style; one of 94: * {@link DateFormat#SHORT}, {@link DateFormat#MEDIUM}, 95: * {@link DateFormat#LONG} or {@link DateFormat#FULL}. 96: * @param locale the desired locale. 97: * @return the localized instance for formatting dates. 98: * @throws NullPointerException if the locale is null. 99: * @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: }