1 package org.apache.maven.doxia.tools;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import java.text.Collator;
23 import java.util.Comparator;
24 import java.util.Locale;
25 import java.util.Objects;
26
27 import org.apache.maven.reporting.MavenReport;
28
29 /**
30 * Sorts reports.
31 *
32 * @author <a href="mailto:brett@apache.org">Brett Porter</a>
33 * TODO move to reporting API?
34 * TODO allow reports to define their order in some other way?
35 */
36 public class ReportComparator
37 implements Comparator<MavenReport>
38 {
39 /** the local */
40 private final Locale locale;
41
42 /**
43 * Default constructor.
44 *
45 * @param locale not null
46 */
47 public ReportComparator( Locale locale )
48 {
49 this.locale = Objects.requireNonNull( locale, "locale cannot be null" );
50 }
51
52 /** {@inheritDoc} */
53 public int compare( MavenReport r1, MavenReport r2 )
54 {
55 Collator collator = Collator.getInstance( locale );
56 return collator.compare( r1.getName( locale ), r2.getName( locale ) );
57 }
58 }