mirror of
https://github.com/openjdk/jdk.git
synced 2025-08-28 15:24:43 +02:00
d15a57b842
Minor coding style update of javadoc tag in any file in java.base Reviewed-by: bchristi, lancea
107 lines
4.4 KiB
Java
107 lines
4.4 KiB
Java
/*
|
|
* Copyright (c) 2005, 2019, Oracle and/or its affiliates. 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. Oracle designates this
|
|
* particular file as subject to the "Classpath" exception as provided
|
|
* by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
* or visit www.oracle.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} 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
|
|
* @throws NullPointerException if {@code locale} is null
|
|
* @throws IllegalArgumentException if {@code locale} 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} 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
|
|
* @throws NullPointerException if {@code locale} is null
|
|
* @throws IllegalArgumentException if {@code locale} 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} 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
|
|
* @throws NullPointerException if {@code locale} is null
|
|
* @throws IllegalArgumentException if {@code locale} 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} 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
|
|
* @throws NullPointerException if {@code locale} is null
|
|
* @throws IllegalArgumentException if {@code locale} 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);
|
|
}
|