17935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert/* 27935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert****************************************************************************** 37935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert* Copyright (C) 1996-2010, International Business Machines Corporation and * 47935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert* others. All Rights Reserved. * 57935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert****************************************************************************** 67935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert*/ 77935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 87935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubertpackage com.ibm.icu.util; 97935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 107935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert/** 117935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * <p>Interface for enabling iteration over sets of <int index, int value>, 127935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * where index is the sorted integer index in ascending order and value, its 137935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * associated integer value.</p> 147935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * <p>The result for each iteration is the consecutive range of 157935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * <int index, int value> with the same value. Result is represented by 167935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * <start, limit, value> where</p> 177935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * <ul> 187935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * <li> start is the starting integer of the result range 197935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * <li> limit is 1 after the maximum integer that follows start, such that 207935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * all integers between start and (limit - 1), inclusive, have the same 217935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * associated integer value. 227935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * <li> value is the integer value that all integers from start to (limit - 1) 237935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * share in common. 247935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * </ul> 257935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * <p> 267935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * Hence value(start) = value(start + 1) = .... = value(start + n) = .... = 277935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * value(limit - 1). However value(start -1) != value(start) and 287935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * value(limit) != value(start). 297935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * </p> 307935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * <p>Most implementations will be created by factory methods, such as the 317935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * character type iterator in UCharacter.getTypeIterator. See example below. 327935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * </p> 337935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * Example of use:<br> 347935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * <pre> 357935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * RangeValueIterator iterator = UCharacter.getTypeIterator(); 367935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * RangeValueIterator.Element result = new RangeValueIterator.Element(); 377935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * while (iterator.next(result)) { 387935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * System.out.println("Codepoint \\u" + 397935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * Integer.toHexString(result.start) + 407935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * " to codepoint \\u" + 417935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * Integer.toHexString(result.limit - 1) + 427935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * " has the character type " + result.value); 437935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * } 447935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * </pre> 457935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * @author synwee 467935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * @stable ICU 2.6 477935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert */ 487935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubertpublic interface RangeValueIterator 497935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert{ 507935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert // public inner class --------------------------------------------- 517935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 527935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert /** 537935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * Return result wrapper for com.ibm.icu.util.RangeValueIterator. 547935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * Stores the start and limit of the continous result range and the 557935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * common value all integers between [start, limit - 1] has. 567935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * @stable ICU 2.6 577935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert */ 587935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert public class Element 597935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert { 607935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert // public data member --------------------------------------------- 617935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 627935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert /** 637935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * Starting integer of the continuous result range that has the same 647935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * value 657935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * @stable ICU 2.6 667935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert */ 677935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert public int start; 687935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert /** 697935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * (End + 1) integer of continuous result range that has the same 707935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * value 717935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * @stable ICU 2.6 727935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert */ 737935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert public int limit; 747935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert /** 757935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * Gets the common value of the continous result range 767935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * @stable ICU 2.6 777935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert */ 787935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert public int value; 797935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 807935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert // public constructor -------------------------------------------- 817935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 827935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert /** 837935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * Empty default constructor to make javadoc happy 847935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * @stable ICU 2.4 857935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert */ 867935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert public Element() 877935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert { 887935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert } 897935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert } 907935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 917935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert // public methods ------------------------------------------------- 927935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 937935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert /** 947935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * <p>Returns the next maximal result range with a common value and returns 957935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * true if we are not at the end of the iteration, false otherwise.</p> 967935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * <p>If this returns a false, the contents of elements will not 977935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * be updated.</p> 987935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * @param element for storing the result range and value 997935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * @return true if we are not at the end of the iteration, false otherwise. 1007935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * @see Element 1017935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * @stable ICU 2.6 1027935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert */ 1037935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert public boolean next(Element element); 1047935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 1057935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert /** 1067935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * Resets the iterator to the beginning of the iteration. 1077935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert * @stable ICU 2.6 1087935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert */ 1097935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert public void reset(); 1107935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert} 111