1 /* BreakIteratorProvider.java -- Providers of localized instances 2 Copyright (C) 2007 Free Software Foundation, Inc. 3 4 This file is part of GNU Classpath. 5 6 GNU Classpath is free software; you can redistribute it and/or modify 7 it under the terms of the GNU General Public License as published by 8 the Free Software Foundation; either version 2, or (at your option) 9 any later version. 10 11 GNU Classpath is distributed in the hope that it will be useful, but 12 WITHOUT ANY WARRANTY; without even the implied warranty of 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 General Public License for more details. 15 16 You should have received a copy of the GNU General Public License 17 along with GNU Classpath; see the file COPYING. If not, write to the 18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 19 02110-1301 USA. 20 21 Linking this library statically or dynamically with other modules is 22 making a combined work based on this library. Thus, the terms and 23 conditions of the GNU General Public License cover the whole 24 combination. 25 26 As a special exception, the copyright holders of this library give you 27 permission to link this library with independent modules to produce an 28 executable, regardless of the license terms of these independent 29 modules, and to copy and distribute the resulting executable under 30 terms of your choice, provided that you also meet, for each linked 31 independent module, the terms and conditions of the license of that 32 module. An independent module is a module which is not derived from 33 or based on this library. If you modify this library, you may extend 34 this exception to your version of the library, but you are not 35 obligated to do so. If you do not wish to do so, delete this 36 exception statement from your version. */ 37 38 package java.text.spi; 39 40 import java.text.BreakIterator; 41 42 import java.util.Locale; 43 44 import java.util.spi.LocaleServiceProvider; 45 46 /** 47 * A {@link BreakIteratorProvider} provides localized 48 * instances of {@link java.text.BreakIterator}. 49 * 50 * @author Andrew John Hughes (gnu_andrew@member.fsf.org) 51 * @since 1.6 52 */ 53 public abstract class BreakIteratorProvider 54 extends LocaleServiceProvider 55 { 56 57 /** 58 * Constructs a new {@link BreakIteratorProvider}. 59 * Provided for implicit invocation by subclasses. 60 */ BreakIteratorProvider()61 protected BreakIteratorProvider() 62 { 63 } 64 65 /** 66 * Returns a {@link java.text.BreakIterator} instance 67 * for character breaks in the specified 68 * {@link java.util.Locale}. 69 * 70 * @param locale the desired locale. 71 * @return the localized instance for character breaks. 72 * @throws NullPointerException if the locale is null. 73 * @throws IllegalArgumentException if the locale is not one 74 * returned by 75 * {@link getAvailableLocales()} 76 * @see java.text.BreakIterator#getCharacterInstance(java.util.Locale) 77 */ getCharacterInstance(Locale locale)78 public abstract BreakIterator getCharacterInstance(Locale locale); 79 80 /** 81 * Returns a {@link java.text.BreakIterator} instance 82 * for line breaks in the specified {@link java.util.Locale}. 83 * 84 * @param locale the desired locale. 85 * @return the localized instance for line breaks. 86 * @throws NullPointerException if the locale is null. 87 * @throws IllegalArgumentException if the locale is not one 88 * returned by 89 * {@link getAvailableLocales()} 90 * @see java.text.BreakIterator#getLineInstance(java.util.Locale) 91 */ getLineInstance(Locale locale)92 public abstract BreakIterator getLineInstance(Locale locale); 93 94 /** 95 * Returns a {@link java.text.BreakIterator} instance 96 * for sentence breaks in the specified 97 * {@link java.util.Locale}. 98 * 99 * @param locale the desired locale. 100 * @return the localized instance for sentence breaks. 101 * @throws NullPointerException if the locale is null. 102 * @throws IllegalArgumentException if the locale is not one 103 * returned by 104 * {@link getAvailableLocales()} 105 * @see java.text.BreakIterator#getSentenceInstance(java.util.Locale) 106 */ getSentenceInstance(Locale locale)107 public abstract BreakIterator getSentenceInstance(Locale locale); 108 109 /** 110 * Returns a {@link java.text.BreakIterator} instance 111 * for word breaks in the specified 112 * {@link java.util.Locale}. 113 * 114 * @param locale the desired locale. 115 * @return the localized instance for word breaks. 116 * @throws NullPointerException if the locale is null. 117 * @throws IllegalArgumentException if the locale is not one 118 * returned by 119 * {@link getAvailableLocales()} 120 * @see java.text.BreakIterator#getWordInstance(java.util.Locale) 121 */ getWordInstance(Locale locale)122 public abstract BreakIterator getWordInstance(Locale locale); 123 124 } 125