001 /* BreakIteratorProvider.java -- Providers of localized instances
002 Copyright (C) 2007 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038 package java.text.spi;
039
040 import java.text.BreakIterator;
041
042 import java.util.Locale;
043
044 import java.util.spi.LocaleServiceProvider;
045
046 /**
047 * A {@link BreakIteratorProvider} provides localized
048 * instances of {@link java.text.BreakIterator}.
049 *
050 * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
051 * @since 1.6
052 */
053 public abstract class BreakIteratorProvider
054 extends LocaleServiceProvider
055 {
056
057 /**
058 * Constructs a new {@link BreakIteratorProvider}.
059 * Provided for implicit invocation by subclasses.
060 */
061 protected BreakIteratorProvider()
062 {
063 }
064
065 /**
066 * Returns a {@link java.text.BreakIterator} instance
067 * for character breaks in the specified
068 * {@link java.util.Locale}.
069 *
070 * @param locale the desired locale.
071 * @return the localized instance for character breaks.
072 * @throws NullPointerException if the locale is null.
073 * @throws IllegalArgumentException if the locale is not one
074 * returned by
075 * {@link getAvailableLocales()}
076 * @see java.text.BreakIterator#getCharacterInstance(java.util.Locale)
077 */
078 public abstract BreakIterator getCharacterInstance(Locale locale);
079
080 /**
081 * Returns a {@link java.text.BreakIterator} instance
082 * for line breaks in the specified {@link java.util.Locale}.
083 *
084 * @param locale the desired locale.
085 * @return the localized instance for line breaks.
086 * @throws NullPointerException if the locale is null.
087 * @throws IllegalArgumentException if the locale is not one
088 * returned by
089 * {@link getAvailableLocales()}
090 * @see java.text.BreakIterator#getLineInstance(java.util.Locale)
091 */
092 public abstract BreakIterator getLineInstance(Locale locale);
093
094 /**
095 * Returns a {@link java.text.BreakIterator} instance
096 * for sentence breaks in the specified
097 * {@link java.util.Locale}.
098 *
099 * @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 */
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 */
122 public abstract BreakIterator getWordInstance(Locale locale);
123
124 }