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.maven.doxia.tools;
20
21 import java.text.Collator;
22 import java.util.Comparator;
23 import java.util.Locale;
24 import java.util.Objects;
25
26 import org.apache.maven.reporting.MavenReport;
27
28 /**
29 * Sorts reports.
30 *
31 * @author <a href="mailto:brett@apache.org">Brett Porter</a>
32 * TODO move to reporting API?
33 * TODO allow reports to define their order in some other way?
34 */
35 public class ReportComparator implements Comparator<MavenReport> {
36 /** the local */
37 private final Locale locale;
38
39 /**
40 * Default constructor.
41 *
42 * @param locale not null
43 */
44 public ReportComparator(Locale locale) {
45 this.locale = Objects.requireNonNull(locale, "locale cannot be null");
46 }
47
48 /** {@inheritDoc} */
49 public int compare(MavenReport r1, MavenReport r2) {
50 Collator collator = Collator.getInstance(locale);
51 return collator.compare(r1.getName(locale), r2.getName(locale));
52 }
53 }