Added documentation to yang-binding, updated dependencies.

[yangtools.git] / yang / yang-binding / src / main / java / org / opendaylight / yangtools / yang / binding / Augmentable.java

diff --git a/yang/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/Augmentable.java b/yang/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/Augmentable.java
index c7e109dc0fad86dbc30791ead110d9c642f2b9b0..340bd5b46dd2811fd0ba60cf247dad2fe12475fd 100644 (file)
--- a/yang/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/Augmentable.java
+++ b/yang/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/Augmentable.java
@@ -1,13 +1,34 @@
-/*
- * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,
- * and is available at http://www.eclipse.org/legal/epl-v10.html
- */
-package org.opendaylight.yangtools.yang.binding;
-
-public interface Augmentable<T> {
-
-    <E extends Augmentation<T>> E getAugmentation(Class<E> augmentationType);
-}
+/*\r
+ * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
+ *\r
+ * This program and the accompanying materials are made available under the\r
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
+ * and is available at http://www.eclipse.org/legal/epl-v10.html\r
+ */\r
+package org.opendaylight.yangtools.yang.binding;\r
+\r
+/**\r
+ * Augmentable (extensible) object which could carry additional data defined by\r
+ * third-party extension, without introducing conflict between various\r
+ * extension.\r
+ * \r
+ * This interface uses extended version of ExtensibleInterface pattern which\r
+ * also adds marker interface for augmentations (extensions) -\r
+ * {@link Augmentable}\r
+ * \r
+ * @author Tony Tkacik <ttkacik@cisco.com>\r
+ * @param <T>\r
+ *            Base class which should implements this interface and is target\r
+ *            for augmentation.\r
+ */\r
+public interface Augmentable<T> {\r
+\r
+    /**\r
+     * Returns instance of augmentation.\r
+     * \r
+     * @param augmentationType\r
+     *            Type of augmentation to be returned.\r
+     * @return instance of augmentation.\r
+     */\r
+    <E extends Augmentation<T>> E getAugmentation(Class<E> augmentationType);\r
+}\r