ICU-10507 Better API documentation for asymmetric search (J)

X-SVN-Rev: 35503
This commit is contained in:
Peter Edberg 2014-03-18 21:52:16 +00:00
parent 4696fb6ee5
commit 36b2e91e43
2 changed files with 12 additions and 0 deletions

View file

@ -721,6 +721,13 @@ public abstract class SearchIterator
/**
* Option to control how collation elements are compared.
* The default value will be {@link #STANDARD_ELEMENT_COMPARISON}.
* <p>
* PATTERN_BASE_WEIGHT_IS_WILDCARD supports "asymmetric search" as described in
* <a href="http://www.unicode.org/reports/tr10/#Asymmetric_Search">
* UTS #10 Unicode Collation Algorithm</a>, while ANY_BASE_WEIGHT_IS_WILDCARD
* supports a related option in which "unmarked" characters in either the
* pattern or the searched text are treated as wildcards that match marked or
* unmarked versions of the same character.
*
* @see #setElementComparisonType(ElementComparisonType)
* @see #getElementComparisonType()

View file

@ -96,6 +96,11 @@ import com.ibm.icu.util.ULocale;
* for the pattern "abab" in the text "ababab", where mutually
* exclusive matches only produces the result of 0.
* <p>
* Options are also provided to implement "asymmetric search" as described in
* <a href="http://www.unicode.org/reports/tr10/#Asymmetric_Search">
* UTS #10 Unicode Collation Algorithm</a>, specifically the ElementComparisonType
* values.
* <p>
* Though collator attributes will be taken into consideration while
* performing matches, there are no APIs here for setting and getting the
* attributes. These attributes can be set by getting the collator