/*

 * Copyright 2005 Sun Microsystems, Inc.  All Rights Reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

package java.text.spi;

import java.text.BreakIterator;

import java.util.Locale;

import java.util.spi.LocaleServiceProvider;

/**

 * An abstract class for service providers that

 * provide concrete implementations of the

 * {@link java.text.BreakIterator BreakIterator} class.

 *

 * @since        1.6

 */

public abstract class BreakIteratorProvider extends LocaleServiceProvider {

    /**

     * Sole constructor.  (For invocation by subclass constructors, typically

     * implicit.)

     */

    protected BreakIteratorProvider() {

    }

    /**

     * Returns a new <code>BreakIterator</code> instance

     * for <a href="../BreakIterator.html#word">word breaks</a>

     * for the given locale.

     * @param locale the desired locale

     * @return A break iterator for word breaks

     * @exception NullPointerException if <code>locale</code> is null

     * @exception IllegalArgumentException if <code>locale</code> isn't

     *     one of the locales returned from

     *     {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()

     *     getAvailableLocales()}.

     * @see java.text.BreakIterator#getWordInstance(java.util.Locale)

     */

    public abstract BreakIterator getWordInstance(Locale locale);

    /**

     * Returns a new <code>BreakIterator</code> instance

     * for <a href="../BreakIterator.html#line">line breaks</a>

     * for the given locale.

     * @param locale the desired locale

     * @return A break iterator for line breaks

     * @exception NullPointerException if <code>locale</code> is null

     * @exception IllegalArgumentException if <code>locale</code> isn't

     *     one of the locales returned from

     *     {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()

     *     getAvailableLocales()}.

     * @see java.text.BreakIterator#getLineInstance(java.util.Locale)

     */

    public abstract BreakIterator getLineInstance(Locale locale);

    /**

     * Returns a new <code>BreakIterator</code> instance

     * for <a href="../BreakIterator.html#character">character breaks</a>

     * for the given locale.

     * @param locale the desired locale

     * @return A break iterator for character breaks

     * @exception NullPointerException if <code>locale</code> is null

     * @exception IllegalArgumentException if <code>locale</code> isn't

     *     one of the locales returned from

     *     {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()

     *     getAvailableLocales()}.

     * @see java.text.BreakIterator#getCharacterInstance(java.util.Locale)

     */

    public abstract BreakIterator getCharacterInstance(Locale locale);

    /**

     * Returns a new <code>BreakIterator</code> instance

     * for <a href="../BreakIterator.html#sentence">sentence breaks</a>

     * for the given locale.

     * @param locale the desired locale

     * @return A break iterator for sentence breaks

     * @exception NullPointerException if <code>locale</code> is null

     * @exception IllegalArgumentException if <code>locale</code> isn't

     *     one of the locales returned from

     *     {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()

     *     getAvailableLocales()}.

     * @see java.text.BreakIterator#getSentenceInstance(java.util.Locale)

     */

    public abstract BreakIterator getSentenceInstance(Locale locale);

}