jdk/src/java.base/share/classes/java/text/Collator.java
changeset 32649 2ee9017c7597
parent 25859 3317bb8137f4
child 45434 4582657c7260
equal deleted inserted replaced
32648:1fa861caf840 32649:2ee9017c7597
   134      * to language features is locale dependant. A common example is for
   134      * to language features is locale dependant. A common example is for
   135      * different base letters ("a" vs "b") to be considered a PRIMARY difference.
   135      * different base letters ("a" vs "b") to be considered a PRIMARY difference.
   136      * @see java.text.Collator#setStrength
   136      * @see java.text.Collator#setStrength
   137      * @see java.text.Collator#getStrength
   137      * @see java.text.Collator#getStrength
   138      */
   138      */
   139     public final static int PRIMARY = 0;
   139     public static final int PRIMARY = 0;
   140     /**
   140     /**
   141      * Collator strength value.  When set, only SECONDARY and above differences are
   141      * Collator strength value.  When set, only SECONDARY and above differences are
   142      * considered significant during comparison. The assignment of strengths
   142      * considered significant during comparison. The assignment of strengths
   143      * to language features is locale dependant. A common example is for
   143      * to language features is locale dependant. A common example is for
   144      * different accented forms of the same base letter ("a" vs "\u00E4") to be
   144      * different accented forms of the same base letter ("a" vs "\u00E4") to be
   145      * considered a SECONDARY difference.
   145      * considered a SECONDARY difference.
   146      * @see java.text.Collator#setStrength
   146      * @see java.text.Collator#setStrength
   147      * @see java.text.Collator#getStrength
   147      * @see java.text.Collator#getStrength
   148      */
   148      */
   149     public final static int SECONDARY = 1;
   149     public static final int SECONDARY = 1;
   150     /**
   150     /**
   151      * Collator strength value.  When set, only TERTIARY and above differences are
   151      * Collator strength value.  When set, only TERTIARY and above differences are
   152      * considered significant during comparison. The assignment of strengths
   152      * considered significant during comparison. The assignment of strengths
   153      * to language features is locale dependant. A common example is for
   153      * to language features is locale dependant. A common example is for
   154      * case differences ("a" vs "A") to be considered a TERTIARY difference.
   154      * case differences ("a" vs "A") to be considered a TERTIARY difference.
   155      * @see java.text.Collator#setStrength
   155      * @see java.text.Collator#setStrength
   156      * @see java.text.Collator#getStrength
   156      * @see java.text.Collator#getStrength
   157      */
   157      */
   158     public final static int TERTIARY = 2;
   158     public static final int TERTIARY = 2;
   159 
   159 
   160     /**
   160     /**
   161      * Collator strength value.  When set, all differences are
   161      * Collator strength value.  When set, all differences are
   162      * considered significant during comparison. The assignment of strengths
   162      * considered significant during comparison. The assignment of strengths
   163      * to language features is locale dependant. A common example is for control
   163      * to language features is locale dependant. A common example is for control
   166      * level.  Additionally, differences between pre-composed accents such as
   166      * level.  Additionally, differences between pre-composed accents such as
   167      * "\u00C0" (A-grave) and combining accents such as "A\u0300"
   167      * "\u00C0" (A-grave) and combining accents such as "A\u0300"
   168      * (A, combining-grave) will be considered significant at the IDENTICAL
   168      * (A, combining-grave) will be considered significant at the IDENTICAL
   169      * level if decomposition is set to NO_DECOMPOSITION.
   169      * level if decomposition is set to NO_DECOMPOSITION.
   170      */
   170      */
   171     public final static int IDENTICAL = 3;
   171     public static final int IDENTICAL = 3;
   172 
   172 
   173     /**
   173     /**
   174      * Decomposition mode value. With NO_DECOMPOSITION
   174      * Decomposition mode value. With NO_DECOMPOSITION
   175      * set, accented characters will not be decomposed for collation. This
   175      * set, accented characters will not be decomposed for collation. This
   176      * is the default setting and provides the fastest collation but
   176      * is the default setting and provides the fastest collation but
   177      * will only produce correct results for languages that do not use accents.
   177      * will only produce correct results for languages that do not use accents.
   178      * @see java.text.Collator#getDecomposition
   178      * @see java.text.Collator#getDecomposition
   179      * @see java.text.Collator#setDecomposition
   179      * @see java.text.Collator#setDecomposition
   180      */
   180      */
   181     public final static int NO_DECOMPOSITION = 0;
   181     public static final int NO_DECOMPOSITION = 0;
   182 
   182 
   183     /**
   183     /**
   184      * Decomposition mode value. With CANONICAL_DECOMPOSITION
   184      * Decomposition mode value. With CANONICAL_DECOMPOSITION
   185      * set, characters that are canonical variants according to Unicode
   185      * set, characters that are canonical variants according to Unicode
   186      * standard will be decomposed for collation. This should be used to get
   186      * standard will be decomposed for collation. This should be used to get
   191      * <a href="http://www.unicode.org/unicode/reports/tr15/tr15-23.html">Unicode
   191      * <a href="http://www.unicode.org/unicode/reports/tr15/tr15-23.html">Unicode
   192      * Technical Report #15</a>.
   192      * Technical Report #15</a>.
   193      * @see java.text.Collator#getDecomposition
   193      * @see java.text.Collator#getDecomposition
   194      * @see java.text.Collator#setDecomposition
   194      * @see java.text.Collator#setDecomposition
   195      */
   195      */
   196     public final static int CANONICAL_DECOMPOSITION = 1;
   196     public static final int CANONICAL_DECOMPOSITION = 1;
   197 
   197 
   198     /**
   198     /**
   199      * Decomposition mode value. With FULL_DECOMPOSITION
   199      * Decomposition mode value. With FULL_DECOMPOSITION
   200      * set, both Unicode canonical variants and Unicode compatibility variants
   200      * set, both Unicode canonical variants and Unicode compatibility variants
   201      * will be decomposed for collation.  This causes not only accented
   201      * will be decomposed for collation.  This causes not only accented
   210      * <a href="http://www.unicode.org/unicode/reports/tr15/tr15-23.html">Unicode
   210      * <a href="http://www.unicode.org/unicode/reports/tr15/tr15-23.html">Unicode
   211      * Technical Report #15</a>.
   211      * Technical Report #15</a>.
   212      * @see java.text.Collator#getDecomposition
   212      * @see java.text.Collator#getDecomposition
   213      * @see java.text.Collator#setDecomposition
   213      * @see java.text.Collator#setDecomposition
   214      */
   214      */
   215     public final static int FULL_DECOMPOSITION = 2;
   215     public static final int FULL_DECOMPOSITION = 2;
   216 
   216 
   217     /**
   217     /**
   218      * Gets the Collator for the current default locale.
   218      * Gets the Collator for the current default locale.
   219      * The default locale is determined by java.util.Locale.getDefault.
   219      * The default locale is determined by java.util.Locale.getDefault.
   220      * @return the Collator for the default locale.(for example, en_US)
   220      * @return the Collator for the default locale.(for example, en_US)
   470 
   470 
   471     /**
   471     /**
   472      * Generates the hash code for this Collator.
   472      * Generates the hash code for this Collator.
   473      */
   473      */
   474     @Override
   474     @Override
   475     abstract public int hashCode();
   475     public abstract int hashCode();
   476 
   476 
   477     /**
   477     /**
   478      * Default constructor.  This constructor is
   478      * Default constructor.  This constructor is
   479      * protected so subclasses can get access to it. Users typically create
   479      * protected so subclasses can get access to it. Users typically create
   480      * a Collator sub-class by calling the factory method getInstance.
   480      * a Collator sub-class by calling the factory method getInstance.
   497     /**
   497     /**
   498      * LESS is returned if source string is compared to be less than target
   498      * LESS is returned if source string is compared to be less than target
   499      * string in the compare() method.
   499      * string in the compare() method.
   500      * @see java.text.Collator#compare
   500      * @see java.text.Collator#compare
   501      */
   501      */
   502     final static int LESS = -1;
   502     static final int LESS = -1;
   503     /**
   503     /**
   504      * EQUAL is returned if source string is compared to be equal to target
   504      * EQUAL is returned if source string is compared to be equal to target
   505      * string in the compare() method.
   505      * string in the compare() method.
   506      * @see java.text.Collator#compare
   506      * @see java.text.Collator#compare
   507      */
   507      */
   508     final static int EQUAL = 0;
   508     static final int EQUAL = 0;
   509     /**
   509     /**
   510      * GREATER is returned if source string is compared to be greater than
   510      * GREATER is returned if source string is compared to be greater than
   511      * target string in the compare() method.
   511      * target string in the compare() method.
   512      * @see java.text.Collator#compare
   512      * @see java.text.Collator#compare
   513      */
   513      */
   514     final static int GREATER = 1;
   514     static final int GREATER = 1;
   515  }
   515  }