• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2005, 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.text.spi;
27 
28 import java.text.Collator;
29 import java.util.Locale;
30 import java.util.spi.LocaleServiceProvider;
31 
32 /**
33  * An abstract class for service providers that
34  * provide concrete implementations of the
35  * {@link java.text.Collator Collator} class.
36  *
37  * @since        1.6
38  */
39 public abstract class CollatorProvider extends LocaleServiceProvider {
40 
41     /**
42      * Sole constructor.  (For invocation by subclass constructors, typically
43      * implicit.)
44      */
CollatorProvider()45     protected CollatorProvider() {
46     }
47 
48     /**
49      * Returns a new <code>Collator</code> instance for the specified locale.
50      * @param locale the desired locale.
51      * @return the <code>Collator</code> for the desired locale.
52      * @exception NullPointerException if
53      * <code>locale</code> is null
54      * @exception IllegalArgumentException if <code>locale</code> isn't
55      *     one of the locales returned from
56      *     {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()
57      *     getAvailableLocales()}.
58      * @see java.text.Collator#getInstance(java.util.Locale)
59      */
getInstance(Locale locale)60     public abstract Collator getInstance(Locale locale);
61 }
62