Document the Path concept.

[yangtools.git] / common / concepts / src / main / java / org / opendaylight / yangtools / concepts / Path.java

diff --git a/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/Path.java b/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/Path.java
index d73326432d5f97eb6d2279e91de3b9c80cc7fd5d..8d1467aec07299c374fce4bb678a261cb69241a9 100644 (file)
--- a/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/Path.java
+++ b/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/Path.java
@@ -7,7 +7,21 @@
  */
 package org.opendaylight.yangtools.concepts;
 
+/**
+ * Conceptual representation of a logical path in a tree-like structure, similar to a
+ * {@link java.nio.file.Path}, but more general in terms of what objects it can be applied to.
+ * Paths have an equivalence class, which is captured in the defining type. Paths also have the
+ * notion of containment, where one path is said to contain another path if it the data set
+ * identified by the former contains all elements of the data set represented by later.
+ *
+ * @param <P> Path equivalence class
+ */
 public interface Path<P extends Path<P>> {
-
+    /**
+     * Check if this path contains some other.
+     *
+     * @param other Other path, may not be null.
+     * @return True if this path contains the other.
+     */
     boolean contains(P other);
 }