Add note in Javadoc about the duplication of FilePosition

Related to #2253
junit-team · May 22, 2020 · 2df0b93 · 2df0b93
1 parent 375792d
commit 2df0b93
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/...platform-engine/src/main/java/org/junit/platform/engine/discovery/DiscoverySelectors.java b/...platform-engine/src/main/java/org/junit/platform/engine/discovery/DiscoverySelectors.java
@@ -103,6 +103,7 @@ public static UriSelector selectUri(URI uri) {
 	 * @see FileSelector
 	 * @see #selectFile(File)
 	 * @see #selectFile(String, FilePosition)
+	 * @see #selectFile(File, FilePosition)
 	 * @see #selectDirectory(String)
 	 * @see #selectDirectory(File)
 	 */
@@ -121,6 +122,7 @@ public static FileSelector selectFile(String path) {
 	 * @see FileSelector
 	 * @see #selectFile(String)
 	 * @see #selectFile(File, FilePosition)
+	 * @see #selectFile(String, FilePosition)
 	 * @see #selectDirectory(String)
 	 * @see #selectDirectory(File)
 	 */
@@ -138,6 +140,7 @@ public static FileSelector selectFile(File file) {
 	 * @param position the position inside the file; may be {@code null}
 	 * @see FileSelector
 	 * @see #selectFile(String)
+	 * @see #selectFile(File)
 	 * @see #selectFile(File, FilePosition)
 	 * @see #selectDirectory(String)
 	 * @see #selectDirectory(File)
@@ -158,6 +161,7 @@ public static FileSelector selectFile(String path, FilePosition position) {
 	 * @param position the position inside the file; may be {@code null}
 	 * @see FileSelector
 	 * @see #selectFile(File)
+	 * @see #selectFile(String)
 	 * @see #selectFile(String, FilePosition)
 	 * @see #selectDirectory(String)
 	 * @see #selectDirectory(File)
@@ -300,6 +304,7 @@ public static ClasspathResourceSelector selectClasspathResource(String classpath
 	 * @param classpathResourceName the name of the classpath resource; never
 	 * {@code null} or blank
 	 * @param position the position inside the classpath resource; may be {@code null}
+	 * @see #selectClasspathResource(String)
 	 * @see ClasspathResourceSelector
 	 * @see ClassLoader#getResource(String)
 	 * @see ClassLoader#getResourceAsStream(String)

diff --git a/junit-platform-engine/src/main/java/org/junit/platform/engine/discovery/FilePosition.java b/junit-platform-engine/src/main/java/org/junit/platform/engine/discovery/FilePosition.java
@@ -27,6 +27,11 @@
  * Position inside a file represented by {@linkplain #getLine line} and
  * {@linkplain #getColumn column} numbers.
  *
+ * @implNote This class is a copy of
+ * {@link org.junit.platform.engine.support.descriptor.FilePosition FilePosition},
+ * which is not accessible from this package. The decision to duplicate it is
+ * motivated by an eventual divergence between the two classes in the future.
+ *
  * @since 1.7
  */
 @API(status = STABLE, since = "1.7")