/*
 * Copyright (C) 2008 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.ibm.icu4jni.text;

import com.ibm.icu4jni.util.Resources;
import java.text.CharacterIterator;
import java.text.StringCharacterIterator;
import java.util.Locale;

public abstract class BreakIterator implements Cloneable
{
    protected static final int BI_CHAR_INSTANCE = 1;
    protected static final int BI_WORD_INSTANCE = 2;
    protected static final int BI_LINE_INSTANCE = 3;
    protected static final int BI_SENT_INSTANCE = 4;
    
    protected int type = 0;
    
    public static Locale[] getAvailableLocales() {
        return Resources.localesFromStrings(NativeBreakIterator.getAvailableLocalesImpl());
    }
    
    public static BreakIterator getCharacterInstance() {
        int iter = NativeBreakIterator.getCharacterInstanceImpl("");
        return new RuleBasedBreakIterator(iter, BI_CHAR_INSTANCE);
    }

    public static BreakIterator getCharacterInstance(Locale where) {
        int iter = NativeBreakIterator.getCharacterInstanceImpl(where.toString());
        return new RuleBasedBreakIterator(iter, BI_CHAR_INSTANCE);
    }

    public static BreakIterator getLineInstance() {
        int iter = NativeBreakIterator.getLineInstanceImpl("");
        return new RuleBasedBreakIterator(iter, BI_LINE_INSTANCE);
    }
    
    public static BreakIterator getLineInstance(Locale where) {
        int iter = NativeBreakIterator.getLineInstanceImpl(where.toString());
        return new RuleBasedBreakIterator(iter, BI_LINE_INSTANCE);
    }
    
    public static BreakIterator getSentenceInstance() {
        int iter = NativeBreakIterator.getSentenceInstanceImpl("");
        return new RuleBasedBreakIterator(iter, BI_SENT_INSTANCE);
    }

    public static BreakIterator getSentenceInstance(Locale where) {
        int iter = NativeBreakIterator.getSentenceInstanceImpl(where.toString());
        return new RuleBasedBreakIterator(iter, BI_SENT_INSTANCE);
    }
    
    public static BreakIterator getWordInstance() {
        int iter = NativeBreakIterator.getWordInstanceImpl("");
        return new RuleBasedBreakIterator(iter, BI_WORD_INSTANCE);
    }

    public static BreakIterator getWordInstance(Locale where) {
        int iter = NativeBreakIterator.getWordInstanceImpl(where.toString());
        return new RuleBasedBreakIterator(iter, BI_WORD_INSTANCE);
    }

    public void setText(String newText) {
        setText(new StringCharacterIterator(newText));
    }

    public abstract boolean isBoundary(int offset);

    public abstract int preceding(int offset);
    
    public abstract Object clone();

    public abstract int current();

    public abstract int first();

    public abstract int following(int offset);

    public abstract CharacterIterator getText();

    public abstract int last();

    public abstract int next(int n);

    public abstract int next();

    public abstract int previous();

    public abstract void setText(CharacterIterator newText);

}