0N/A/*
2362N/A * Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
2362N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
2362N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
2362N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
2362N/A * or visit www.oracle.com if you need additional information or have any
2362N/A * questions.
0N/A */
0N/A
0N/A/*
0N/A *******************************************************************************
0N/A * (C) Copyright IBM Corp. 1996-2005 - All Rights Reserved *
0N/A * *
0N/A * The original version of this source code and documentation is copyrighted *
0N/A * and owned by IBM, These materials are provided under terms of a License *
0N/A * Agreement between IBM and Sun. This technology is protected by multiple *
0N/A * US and International patents. This notice and attribution to IBM may not *
0N/A * to removed. *
0N/A *******************************************************************************
0N/A */
0N/A
0N/Apackage sun.text.normalizer;
0N/A
0N/Aimport java.text.ParsePosition;
0N/A
0N/A/**
0N/A * An interface that defines both lookup protocol and parsing of
0N/A * symbolic names.
0N/A *
0N/A * <p>A symbol table maintains two kinds of mappings. The first is
0N/A * between symbolic names and their values. For example, if the
0N/A * variable with the name "start" is set to the value "alpha"
0N/A * (perhaps, though not necessarily, through an expression such as
0N/A * "$start=alpha"), then the call lookup("start") will return the
0N/A * char[] array ['a', 'l', 'p', 'h', 'a'].
0N/A *
0N/A * <p>The second kind of mapping is between character values and
0N/A * UnicodeMatcher objects. This is used by RuleBasedTransliterator,
0N/A * which uses characters in the private use area to represent objects
0N/A * such as UnicodeSets. If U+E015 is mapped to the UnicodeSet [a-z],
0N/A * then lookupMatcher(0xE015) will return the UnicodeSet [a-z].
0N/A *
0N/A * <p>Finally, a symbol table defines parsing behavior for symbolic
0N/A * names. All symbolic names start with the SYMBOL_REF character.
0N/A * When a parser encounters this character, it calls parseReference()
0N/A * with the position immediately following the SYMBOL_REF. The symbol
0N/A * table parses the name, if there is one, and returns it.
0N/A *
0N/A * @draft ICU 2.8
0N/A * @deprecated This is a draft API and might change in a future release of ICU.
0N/A */
0N/Apublic interface SymbolTable {
0N/A
0N/A /**
0N/A * The character preceding a symbol reference name.
0N/A * @draft ICU 2.8
0N/A * @deprecated This is a draft API and might change in a future release of ICU.
0N/A */
0N/A static final char SYMBOL_REF = '$';
0N/A
0N/A /**
0N/A * Lookup the characters associated with this string and return it.
0N/A * Return <tt>null</tt> if no such name exists. The resultant
0N/A * array may have length zero.
0N/A * @param s the symbolic name to lookup
0N/A * @return a char array containing the name's value, or null if
0N/A * there is no mapping for s.
0N/A * @draft ICU 2.8
0N/A * @deprecated This is a draft API and might change in a future release of ICU.
0N/A */
0N/A char[] lookup(String s);
0N/A
0N/A /**
0N/A * Lookup the UnicodeMatcher associated with the given character, and
0N/A * return it. Return <tt>null</tt> if not found.
0N/A * @param ch a 32-bit code point from 0 to 0x10FFFF inclusive.
0N/A * @return the UnicodeMatcher object represented by the given
0N/A * character, or null if there is no mapping for ch.
0N/A * @draft ICU 2.8
0N/A * @deprecated This is a draft API and might change in a future release of ICU.
0N/A */
0N/A UnicodeMatcher lookupMatcher(int ch);
0N/A
0N/A /**
0N/A * Parse a symbol reference name from the given string, starting
0N/A * at the given position. If no valid symbol reference name is
0N/A * found, return null and leave pos unchanged. That is, if the
0N/A * character at pos cannot start a name, or if pos is at or after
0N/A * text.length(), then return null. This indicates an isolated
0N/A * SYMBOL_REF character.
0N/A * @param text the text to parse for the name
0N/A * @param pos on entry, the index of the first character to parse.
0N/A * This is the character following the SYMBOL_REF character. On
0N/A * exit, the index after the last parsed character. If the parse
0N/A * failed, pos is unchanged on exit.
0N/A * @param limit the index after the last character to be parsed.
0N/A * @return the parsed name, or null if there is no valid symbolic
0N/A * name at the given position.
0N/A * @draft ICU 2.8
0N/A * @deprecated This is a draft API and might change in a future release of ICU.
0N/A */
0N/A String parseReference(String text, ParsePosition pos, int limit);
0N/A}