001    /* 
002        Licensed to the Apache Software Foundation (ASF) under one
003        or more contributor license agreements.  See the NOTICE file
004        distributed with this work for additional information
005        regarding copyright ownership.  The ASF licenses this file
006        to you under the Apache License, Version 2.0 (the
007        "License"); you may not use this file except in compliance
008        with the License.  You may obtain a copy of the License at
009    
010           http://www.apache.org/licenses/LICENSE-2.0
011    
012        Unless required by applicable law or agreed to in writing,
013        software distributed under the License is distributed on an
014        "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015        KIND, either express or implied.  See the License for the
016        specific language governing permissions and limitations
017        under the License.  
018     */
019    
020    package org.apache.wiki.util.comparators;
021    
022    import java.text.Collator;
023    import java.util.Locale;
024    
025    /**
026     * A comparator that sorts Strings using the locale's collator.
027     * 
028     */
029    public class LocaleComparator extends CollatorComparator
030    {
031        /**
032         * Default constructor uses the current locale's collator.
033         */
034        public LocaleComparator()
035        {
036            m_collator = Collator.getInstance();
037        }
038    
039        /**
040         * use a specific locale's collator.
041         */
042        public LocaleComparator( Locale locale )
043        {
044            m_collator = Collator.getInstance( locale );
045        }
046    
047        /**
048         * Specify a new locale.
049         * 
050         * @param locale the locale for future comparisons
051         */
052        public void setLocale( Locale locale)
053        {
054            m_collator = Collator.getInstance(locale);
055        }
056    }