KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > java > text > spi > CollatorProvider


1 /*
2  * @(#)CollatorProvider.java 1.2 05/11/17
3  *
4  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
5  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
6  */
7
8 package java.text.spi;
9
10 import java.text.Collator JavaDoc;
11 import java.util.Locale JavaDoc;
12 import java.util.spi.LocaleServiceProvider;
13
14 /**
15  * An abstract class for service providers that
16  * provide concrete implementations of the
17  * {@link java.text.Collator Collator} class.
18  *
19  * @since 1.6
20  * @version @(#)CollatorProvider.java 1.2 05/11/17
21  */
22 public abstract class CollatorProvider extends LocaleServiceProvider {
23
24     /**
25      * Sole constructor. (For invocation by subclass constructors, typically
26      * implicit.)
27      */
28     protected CollatorProvider() {
29     }
30
31     /**
32      * Returns a new <code>Collator</code> instance for the specified locale.
33      * @param locale the desired locale.
34      * @return the <code>Collator</code> for the desired locale.
35      * @exception NullPointerException if
36      * <code>locale</code> is null
37      * @exception IllegalArgumentException if <code>locale</code> isn't
38      * one of the locales returned from
39      * {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()
40      * getAvailableLocales()}.
41      * @see java.text.Collator#getInstance(java.util.Locale)
42      */
43     public abstract Collator JavaDoc getInstance(Locale JavaDoc locale);
44 }
45
Popular Tags