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 /** 23 * Common specification for a JavaDoc location which can be compared and sorted. 24 * JavaDoc locations must be comparable and also convert-able to unique strings. 25 * 26 * @author <a href="mailto:lj@jguru.se">Lennart Jörelid</a>, jGuru Europe AB 27 * @since 2.0 28 */ 29 public interface SortableLocation extends Comparable<SortableLocation> { 30 31 /** 32 * Validates if the supplied path is equal to this SortableLocation. 33 * 34 * @param path The non-null path to compare to this SortableLocation. 35 * @return {@code true} if this SortableLocation is equal to the supplied path. 36 */ 37 boolean isEqualToPath(final String path); 38 39 /** 40 * Retrieves the path of this SortableLocation. The path must uniquely correspond to each unique SortableLocation, 41 * implying that SortableLocations could be sorted and compared for equality using the path property. 42 * 43 * @return the path of this SortableLocation. Never null. 44 */ 45 String getPath(); 46 }