Skip to content

Commit

Permalink
Fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
gnodet committed Aug 23, 2023
1 parent 2da261f commit c009db4
Showing 1 changed file with 14 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -27,20 +27,29 @@
public interface ModelSource3 extends ModelSource2 {
/**
* Returns model source identified by a path relative to this model source POM. Implementation <strong>MUST</strong>
* be able to accept <code>relPath</code> parameter values that
* 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, in the latter case 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.</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 relPath is the path of the requested model source relative to this model source POM.
* @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
*/
@Deprecated
default ModelSource3 getRelatedSource(String relPath) {
return getRelatedSource(null, relPath);
}
Expand Down

0 comments on commit c009db4

Please sign in to comment.