gnodet commented on code in PR #1217: URL: https://github.com/apache/maven/pull/1217#discussion_r1302966910
########## maven-model-builder/src/main/java/org/apache/maven/model/building/ModelSource3.java: ########## @@ -0,0 +1,56 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.maven.model.building; + +import org.apache.maven.model.locator.ModelLocator; + +/** + * Enhancement to the {@link ModelSource2} to support locating POM files using the {@link ModelLocator} + * when pointing to a directory. + */ +public interface ModelSource3 extends ModelSource2 { + /** + * Returns model source identified by a path relative to this model source POM. Implementation <strong>MUST</strong> + * accept <code>relPath</code> parameter values that + * <ul> + * <li>use either / or \ file path separator</li> + * <li>have .. parent directory references</li> + * <li>point either at file or directory</li> + * </ul> + * If the given path points at a directory, the provided {@code ModelLocator} will be used + * to find the POM file, else if no locator is provided, a file named 'pom.xml' needs to be + * used by the requested model source. + * + * @param locator locator used to actually locate the pom file. + * @param relPath path of the requested model source relative to this model source POM. + * @return related model source or <code>null</code> if no such model source. + */ + ModelSource3 getRelatedSource(ModelLocator locator, String relPath); + + /** + * When using a ModelSource3, the method with a {@code ModelLocator} argument should + * be used instead. + * + * @deprecated use {@link #getRelatedSource(ModelLocator, String)} instead Review Comment: This method overrides the `ModelSource2` method. If the source does not implement `ModelSource3`, then the `ModelSource2.getRelatedSource(String)` will be called, see https://github.com/apache/maven/pull/1217/files#diff-f590407a614fe5e60543bf824d2de0b5df48fddfcbe7c42e64ac1f6606533347R1497 . -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
