BreakIteratorProvider.java revision d2d7abef3e9b73a57cdf1f2afd678d7f48945679 
1/*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements.  See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License.  You may obtain a copy of the License at
8 *
9 *     http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18package java.text.spi;
19
20import java.text.BreakIterator;
21import java.util.Locale;
22import java.util.spi.LocaleServiceProvider;
23
24/**
25 * This abstract class should be extended by service providers that provide
26 * instances of {@code BreakIterator}.
27 * <p>Note that Android does not support user-supplied locale service providers.
28 * @since 1.6
29 * @hide
30 */
31public abstract class BreakIteratorProvider extends LocaleServiceProvider {
32    /**
33     * Default constructor, for use by subclasses.
34     */
35    protected BreakIteratorProvider() {
36        // Do nothing.
37    }
38
39    /**
40     * Returns an instance of {@code BreakIterator} for word breaks in the
41     * given locale.
42     *
43     * @param locale the locale
44     * @return an instance of {@code BreakIterator}
45     * @throws NullPointerException if {@code locale == null}
46     * @throws IllegalArgumentException
47     *             if locale isn't one of the locales returned from
48     *             getAvailableLocales().
49     */
50    public abstract BreakIterator getWordInstance(Locale locale);
51
52    /**
53     * Returns an instance of {@code BreakIterator} for line breaks in the
54     * given locale.
55     *
56     * @param locale the locale
57     * @return an instance of {@code BreakIterator}
58     * @throws NullPointerException if {@code locale == null}
59     * @throws IllegalArgumentException
60     *             if locale isn't one of the locales returned from
61     *             getAvailableLocales().
62     */
63    public abstract BreakIterator getLineInstance(Locale locale);
64
65    /**
66     * Returns an instance of {@code BreakIterator} for character breaks in the
67     * given locale.
68     *
69     * @param locale the locale
70     * @return an instance of {@code BreakIterator}
71     * @throws NullPointerException if {@code locale == null}
72     * @throws IllegalArgumentException
73     *             if locale isn't one of the locales returned from
74     *             getAvailableLocales().
75     */
76    public abstract BreakIterator getCharacterInstance(Locale locale);
77
78    /**
79     * Returns an instance of {@code BreakIterator} for sentence breaks in the
80     * given locale.
81     *
82     * @param locale the locale
83     * @return an instance of {@code BreakIterator}
84     * @throws NullPointerException if {@code locale == null}
85     * @throws IllegalArgumentException
86     *             if locale isn't one of the locales returned from
87     *             getAvailableLocales().
88     */
89    public abstract BreakIterator getSentenceInstance(Locale locale);
90}
91