ICU-2103 javadoc updates, @stable and @drafts addition

X-SVN-Rev: 10430
This commit is contained in:
Syn Wee Quek 2002-12-03 02:14:21 +00:00
parent 2b4c3933a7
commit 61c9cb045e
4 changed files with 938 additions and 847 deletions

View file

@ -0,0 +1,14 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<HTML>
<HEAD>
<TITLE>ICU4J Performance Test Wed Nov 20 13:31:53 2002</TITLE>
</HEAD>
<BODY>
<H1>ICU4J Performance Test Wed Nov 20 13:31:53 2002</H1>
<H2>com.ibm.icu.dev.test.perf.UCharacterPerf</H2>
<P><TABLE BORDER="1" CELLPADDING="4" CELLSPACING="0"><TR><TD>
<P><B>Digit vs. JDKDigit</B></P>
<P><TABLE BORDER="1" CELLPADDING="4" CELLSPACING="0" BGCOLOR="#CCFFFF">
<TR><TD>Pattern</TD><TD>Digit</TD><TD>JDKDigit</TD><TD>Ratio</TD></TR>
<TR><TD>0 ffff</TD>

View file

@ -5,8 +5,8 @@
*******************************************************************************
*
* $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/SearchIterator.java,v $
* $Date: 2002/07/12 21:59:22 $
* $Revision: 1.11 $
* $Date: 2002/12/03 02:14:20 $
* $Revision: 1.12 $
*
*****************************************************************************************
*/
@ -126,8 +126,7 @@ import java.text.CharacterIterator;
* </pre>
* </p>
* @author Laura Werner, synwee
* @since release 1.0
* @draft release 2.2
* @stable ICU 1.0
* @see BreakIterator
*/
public abstract class SearchIterator
@ -140,6 +139,7 @@ public abstract class SearchIterator
* been returned, and by first() and last() if there are no matches at all.
* @see #previous
* @see #next
* @stable ICU 1.0
*/
public static final int DONE = -1;
@ -156,7 +156,7 @@ public abstract class SearchIterator
* @exception IndexOutOfBoundsException thrown if argument position is out
* of the target text range.
* @see #getIndex
* @draft release 2.2
* @draft ICU 2.2
*/
public void setIndex(int position) {
if (position < targetText.getBeginIndex()
@ -180,7 +180,7 @@ public abstract class SearchIterator
* </p>
* @param allowOverlap flag indicator if overlapping matches are allowed
* @see #isOverlapping
* @draft release 2.2
* @draft ICU 2.2
*/
public void setOverlapping(boolean allowOverlap)
{
@ -197,6 +197,7 @@ public abstract class SearchIterator
* points at which matches are detected.
* @see #getBreakIterator
* @see BreakIterator
* @stable ICU 1.0
*/
public void setBreakIterator(BreakIterator breakiter)
{
@ -256,7 +257,7 @@ public abstract class SearchIterator
* @see #previous
* @see #last
* @see #DONE
* @draft release 2.2
* @draft ICU 2.2
*/
public int getMatchStart()
{
@ -270,7 +271,7 @@ public abstract class SearchIterator
* the beginning for a backwards search, {@link #DONE} is returned.
* @return index in the target text at which the iterator is currently
* positioned.
* @draft release 2.2
* @draft ICU 2.2
* @see #first
* @see #next
* @see #previous
@ -298,6 +299,7 @@ public abstract class SearchIterator
* @see #previous
* @see #last
* @see #DONE
* @stable ICU 1.0
*/
public int getMatchLength()
{
@ -313,6 +315,7 @@ public abstract class SearchIterator
* @return the BreakIterator set to restrict logic matches
* @see #setBreakIterator
* @see BreakIterator
* @stable ICU 1.0
*/
public BreakIterator getBreakIterator()
{
@ -323,6 +326,7 @@ public abstract class SearchIterator
* Return the target text that is being searched.
* @return target text being searched.
* @see #setTarget
* @stable ICU 1.0
*/
public CharacterIterator getTarget()
{
@ -343,6 +347,7 @@ public abstract class SearchIterator
* @see #last
* @see #DONE
* @return the substring in the target text of the most recent match
* @stable ICU 1.0
*/
public String getMatchedText()
{
@ -383,6 +388,7 @@ public abstract class SearchIterator
* @see #first
* @see #last
* @see #DONE
* @stable ICU 1.0
*/
public int next()
{
@ -443,6 +449,7 @@ public abstract class SearchIterator
* @see #first
* @see #last
* @see #DONE
* @stable ICU 1.0
*/
public int previous()
{
@ -487,7 +494,7 @@ public abstract class SearchIterator
* See setOverlapping(boolean) for more information.
* @see #setOverlapping
* @return true if the overlapping property has been set, false otherwise
* @draft release 2.2
* @draft ICU 2.2
*/
public boolean isOverlapping()
{
@ -504,7 +511,7 @@ public abstract class SearchIterator
* start of the target text. Otherwise, if a backwards iteration is initiated,
* the next search will begin at the end of the target text.
* </p>
* @draft release 2.2
* @draft ICU 2.2
*/
public void reset()
{
@ -532,6 +539,7 @@ public abstract class SearchIterator
* @see #previous
* @see #last
* @see #DONE
* @stable ICU 1.0
*/
public final int first()
{
@ -556,6 +564,7 @@ public abstract class SearchIterator
* @see #previous
* @see #last
* @see #DONE
* @stable ICU 1.0
*/
public final int following(int position)
{
@ -580,6 +589,7 @@ public abstract class SearchIterator
* @see #previous
* @see #following
* @see #DONE
* @stable ICU 1.0
*/
public final int last()
{
@ -605,6 +615,7 @@ public abstract class SearchIterator
* @see #previous
* @see #last
* @see #DONE
* @stable ICU 1.0
*/
public final int preceding(int position)
{
@ -623,6 +634,7 @@ public abstract class SearchIterator
* @see #setBreakIterator(BreakIterator)
* @see #getBreakIterator
* @see BreakIterator
* @stable ICU 1.0
*/
protected BreakIterator breakIterator;
@ -630,6 +642,7 @@ public abstract class SearchIterator
* Target text for searching.
* @see #setTarget(CharacterIterator)
* @see #getTarget
* @stable ICU 1.0
*/
protected CharacterIterator targetText;
/**
@ -637,6 +650,7 @@ public abstract class SearchIterator
* Value 0 is the default value.
* @see #setMatchLength
* @see #getMatchLength
* @stable ICU 1.0
*/
protected int matchLength;
@ -654,6 +668,7 @@ public abstract class SearchIterator
* @exception IllegalArgumentException thrown when argument target is null,
* or of length 0
* @see BreakIterator
* @stable ICU 1.0
*/
protected SearchIterator(CharacterIterator target, BreakIterator breaker)
{
@ -686,6 +701,7 @@ public abstract class SearchIterator
* @param length new length to set
* @see #handleNext
* @see #handlePrevious
* @stable ICU 1.0
*/
protected void setMatchLength(int length)
{
@ -712,6 +728,7 @@ public abstract class SearchIterator
* @see #setMatchLength(int)
* @see #handlePrevious(int)
* @see #DONE
* @stable ICU 1.0
*/
protected abstract int handleNext(int start);
@ -736,6 +753,7 @@ public abstract class SearchIterator
* @see #setMatchLength(int)
* @see #handleNext(int)
* @see #DONE
* @stable ICU 1.0
*/
protected abstract int handlePrevious(int startAt);

View file

@ -5,8 +5,8 @@
*******************************************************************************
*
* $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/StringSearch.java,v $
* $Date: 2002/09/11 00:12:39 $
* $Revision: 1.14 $
* $Date: 2002/12/03 02:14:21 $
* $Revision: 1.15 $
*
*****************************************************************************************
*/
@ -145,7 +145,7 @@ import com.ibm.icu.impl.NormalizerImpl;
* @see SearchIterator
* @see RuleBasedCollator
* @author Laura Werner, synwee
* @since 1.0
* @stable ICU 1.0
*/
// internal notes: all methods do not guarantee the correct status of the
// characteriterator. the caller has to maintain the original index position
@ -171,6 +171,7 @@ public final class StringSearch extends SearchIterator
* @see BreakIterator
* @see RuleBasedCollator
* @see SearchIterator
* @stable ICU 1.0
*/
public StringSearch(String pattern, CharacterIterator target,
RuleBasedCollator collator, BreakIterator breakiter)
@ -200,6 +201,7 @@ public final class StringSearch extends SearchIterator
* or of length 0
* @see RuleBasedCollator
* @see SearchIterator
* @stable ICU 1.0
*/
public StringSearch(String pattern, CharacterIterator target,
RuleBasedCollator collator)
@ -222,6 +224,7 @@ public final class StringSearch extends SearchIterator
* @see BreakIterator
* @see RuleBasedCollator
* @see SearchIterator
* @stable ICU 1.0
*/
public StringSearch(String pattern, CharacterIterator target, Locale locale)
{
@ -243,6 +246,7 @@ public final class StringSearch extends SearchIterator
* @see BreakIterator
* @see RuleBasedCollator
* @see SearchIterator
* @stable ICU 1.0
*/
public StringSearch(String pattern, String target)
{
@ -261,10 +265,7 @@ public final class StringSearch extends SearchIterator
* @see RuleBasedCollator
* @see #setStrength
* @see #getCollator
* @deprecated since release 2.2, user who would like to access the
* RuleBasedCollator strength, should retrieve the
* RuleBasedCollator via the API getCollator(), and use the
* Collator APIs to retrieve the strength.
* @deprecated ICU 2.2. Use this.getCollator().getStrength() instead.
*/
public int getStrength() {
return m_collator_.getStrength();
@ -284,6 +285,7 @@ public final class StringSearch extends SearchIterator
* @return RuleBasedCollator used by this StringSearch
* @see RuleBasedCollator
* @see #setCollator
* @stable ICU 1.0
*/
public RuleBasedCollator getCollator()
{
@ -293,6 +295,7 @@ public final class StringSearch extends SearchIterator
/**
* Returns the pattern for which StringSearch is searching for.
* @return the pattern searched for
* @stable ICU 1.0
*/
public String getPattern()
{
@ -306,7 +309,7 @@ public final class StringSearch extends SearchIterator
* the beginning for a backwards search, {@link #DONE} is returned.
* @return index in the target text where the iterator is currently
* positioned at
* @draft release 2.2
* @draft ICU 2.2
*/
public int getIndex()
{
@ -323,7 +326,7 @@ public final class StringSearch extends SearchIterator
* See setCanonical(boolean) for more information.
* @see #setCanonical
* @return true if canonical matches is set, false otherwise
* @draft release 2.2
* @draft ICU 2.2
*/
public boolean isCanonical()
{
@ -337,11 +340,9 @@ public final class StringSearch extends SearchIterator
* Sets the strength property of the RuleBasedCollator used for searching.
* See the Collator documentation for a description of the strengths.
* </p>
* @deprecated since release 2.2, user who would like to modify the
* RuleBasedCollator, should retrieve the RuleBasedCollator
* via the API getCollator(), and use the Collator APIs to
* modify the strength. After which StringSearch.reset()
* or StringSearch.setCollator(RuleBasedCollator) should be
* @deprecated ICU 2.2. Use this.getCollator().setStrength(int) instead.
* After which StringSearch.reset()
* or StringSearch.setCollator(this.getCollator()) should be
* called to update StringSearch.
* @see Collator
* @see Collator#PRIMARY
@ -401,6 +402,7 @@ public final class StringSearch extends SearchIterator
* @see #getPattern
* @exception IllegalArgumentException thrown if pattern is null or of
* length 0
* @stable ICU 1.0
*/
public void setPattern(String pattern)
{
@ -420,7 +422,7 @@ public final class StringSearch extends SearchIterator
* @exception IllegalArgumentException thrown when text is null or has
* 0 length
* @see #getTarget
* @draft release 2.2
* @draft ICU 2.2
*/
public void setTarget(CharacterIterator text)
{
@ -448,7 +450,7 @@ public final class StringSearch extends SearchIterator
* @exception IndexOutOfBoundsException thrown if argument position is out
* of the target text range.
* @see #getIndex
* @draft release 2.2
* @draft ICU 2.2
*/
public void setIndex(int position)
{
@ -464,7 +466,7 @@ public final class StringSearch extends SearchIterator
* </p>
* @param allowCanonical flag indicator if canonical matches are allowed
* @see #isCanonical
* @draft release 2.2
* @draft ICU 2.2
*/
public void setCanonical(boolean allowCanonical)
{
@ -503,7 +505,7 @@ public final class StringSearch extends SearchIterator
* <p>
* Canonical match option will be reset to false, ie an exact match.
* </p>
* @draft release 2.2
* @draft ICU 2.2
*/
public void reset()
{
@ -534,6 +536,7 @@ public final class StringSearch extends SearchIterator
* otherwise
* @see #handlePrevious(int)
* @see #DONE
* @draft ICU 2.2
*/
protected int handleNext(int start)
{
@ -602,6 +605,7 @@ public final class StringSearch extends SearchIterator
* otherwise
* @see #handleNext(int)
* @see #DONE
* @draft ICU 2.2
*/
protected int handlePrevious(int start)
{

File diff suppressed because it is too large Load diff