From 0c76d519b15a34794a9201ddcaf603914439053a Mon Sep 17 00:00:00 2001 From: Robert Varga Date: Wed, 4 Feb 2015 12:44:55 +0100 Subject: [PATCH] Document the Path concept. Adds a javadoc clarification to the concept, which allows its implementations to be documented as well. Change-Id: Ib6d7c09a23975659359ddfeeea1be688864590c1 Signed-off-by: Robert Varga --- .../opendaylight/yangtools/concepts/Path.java | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) 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 d73326432d..8d1467aec0 100644 --- 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

Path equivalence class + */ public interface Path

> { - + /** + * 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); } -- 2.36.6