View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.myfaces.trinidad.model;
20  
21  import java.text.Collator;
22  
23  /**
24   * This class provides an enumeration to work with the integer values of the
25   * {@link Collator} strength values.
26   */
27  public enum SortStrength
28  {
29    /** @see Collator#IDENTICAL */
30    IDENTICAL(Collator.IDENTICAL),
31    /** @see Collator#PRIMARY */
32    PRIMARY(Collator.PRIMARY),
33    /** @see Collator#SECONDARY */
34    SECONDARY(Collator.SECONDARY),
35    /** @see Collator#TERTIARY */
36    TERTIARY(Collator.TERTIARY);
37  
38    private SortStrength(int strength)
39    {
40      _strength = strength;
41    }
42  
43    /**
44     * retrieves the strength, the integer strength value matches that of the {@link Collator}
45     * @return strength value which matches {@link Collator} strength values.
46     */
47    public int getStrength()
48    {
49      return _strength;
50    }
51  
52    private final int _strength;
53  }