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.BreakIterator; 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.BreakIterator BreakIterator} class. 36 * 37 * @since 1.6 38 */ 39 public abstract class BreakIteratorProvider extends LocaleServiceProvider { 40 41 /** 42 * Sole constructor. (For invocation by subclass constructors, typically 43 * implicit.) 44 */ 45 protected BreakIteratorProvider() { 46 } 47 48 /** 49 * Returns a new <code>BreakIterator</code> instance 50 * for <a href="../BreakIterator.html#word">word breaks</a> 51 * for the given locale. 52 * @param locale the desired locale 53 * @return A break iterator for word breaks 54 * @exception NullPointerException if <code>locale</code> is null 55 * @exception IllegalArgumentException if <code>locale</code> isn't 56 * one of the locales returned from 57 * {@link java.util.spi.LocaleServiceProvider#getAvailableLocales() 58 * getAvailableLocales()}. 59 * @see java.text.BreakIterator#getWordInstance(java.util.Locale) 60 */ 61 public abstract BreakIterator getWordInstance(Locale locale); 62 63 /** 64 * Returns a new <code>BreakIterator</code> instance 65 * for <a href="../BreakIterator.html#line">line breaks</a> 66 * for the given locale. 67 * @param locale the desired locale 68 * @return A break iterator for line breaks 69 * @exception NullPointerException if <code>locale</code> is null 70 * @exception IllegalArgumentException if <code>locale</code> isn't 71 * one of the locales returned from 72 * {@link java.util.spi.LocaleServiceProvider#getAvailableLocales() 73 * getAvailableLocales()}. 74 * @see java.text.BreakIterator#getLineInstance(java.util.Locale) 75 */ 76 public abstract BreakIterator getLineInstance(Locale locale); 77 78 /** 79 * Returns a new <code>BreakIterator</code> instance 80 * for <a href="../BreakIterator.html#character">character breaks</a> 81 * for the given locale. 82 * @param locale the desired locale 83 * @return A break iterator for character breaks 84 * @exception NullPointerException if <code>locale</code> is null 85 * @exception IllegalArgumentException if <code>locale</code> isn't 86 * one of the locales returned from 87 * {@link java.util.spi.LocaleServiceProvider#getAvailableLocales() 88 * getAvailableLocales()}. 89 * @see java.text.BreakIterator#getCharacterInstance(java.util.Locale) 90 */ 91 public abstract BreakIterator getCharacterInstance(Locale locale); 92 93 /** 94 * Returns a new <code>BreakIterator</code> instance 95 * for <a href="../BreakIterator.html#sentence">sentence breaks</a> 96 * for the given locale. 97 * @param locale the desired locale 98 * @return A break iterator for sentence breaks 99 * @exception NullPointerException if <code>locale</code> is null 100 * @exception IllegalArgumentException if <code>locale</code> isn't 101 * one of the locales returned from 102 * {@link java.util.spi.LocaleServiceProvider#getAvailableLocales() 103 * getAvailableLocales()}. 104 * @see java.text.BreakIterator#getSentenceInstance(java.util.Locale) 105 */ 106 public abstract BreakIterator getSentenceInstance(Locale locale); 107 }