1 package org.codehaus.mojo.jaxb2.schemageneration.postprocessing.javadoc;
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 javax.xml.bind.annotation.XmlAttribute;
23 import javax.xml.bind.annotation.XmlElement;
24 import javax.xml.bind.annotation.XmlType;
25
26 /**
27 * Common specification for a JavaDoc location which can be compared and sorted.
28 * JavaDoc locations must be comparable and also convert-able to unique strings.
29 *
30 * @author <a href="mailto:lj@jguru.se">Lennart Jörelid</a>, jGuru Europe AB
31 * @since 2.0
32 */
33 public interface SortableLocation extends Comparable<SortableLocation> {
34
35 /**
36 * Validates if the supplied path is equal to this SortableLocation.
37 *
38 * @param path The non-null path to compare to this SortableLocation.
39 * @return {@code true} if this SortableLocation is equal to the supplied path.
40 */
41 boolean isEqualToPath(final String path);
42
43 /**
44 * Retrieves the path of this SortableLocation. The path must uniquely correspond to each unique SortableLocation,
45 * implying that SortableLocations could be sorted and compared for equality using the path property.
46 *
47 * @return the path of this SortableLocation. Never null.
48 */
49 String getPath();
50
51 /**
52 * Retrieves the value of the name attribute provided by a JAXB annotation, implying that
53 * the XSD type should use another name than the default.
54 *
55 * @return the value of the name attribute provided by a JAXB annotation relevant to this {@link SortableLocation}.
56 * @see XmlElement#name()
57 * @see XmlAttribute#name()
58 * @see XmlType#name()
59 */
60 String getAnnotationRenamedTo();
61 }