From 1c94a7cbeee99477aed0fe6d06e3b075ce8e2885 Mon Sep 17 00:00:00 2001 From: Robert Varga Date: Sat, 2 Jan 2016 14:52:02 +0100 Subject: [PATCH] Cleanup yang.model.api.meta Add proper separators, trim unneeded empty lines, clarify non-null return of getEffectiveSubstatements(). Change-Id: Ie756cdcf26105556c8be84ccd0df271200c6a968 Signed-off-by: Robert Varga --- .../yang/model/api/meta/DeclaredStatement.java | 4 +--- .../yang/model/api/meta/EffectiveStatement.java | 12 +++--------- .../yang/model/api/meta/IdentifierNamespace.java | 5 +---- .../yang/model/api/meta/ModelStatement.java | 4 ---- .../yang/model/api/meta/StatementDefinition.java | 9 --------- .../yang/model/api/meta/StatementSource.java | 9 ++------- .../yangtools/yang/model/api/meta/package-info.java | 1 + 7 files changed, 8 insertions(+), 36 deletions(-) diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/DeclaredStatement.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/DeclaredStatement.java index dbe80e96f2..54d83326a9 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/DeclaredStatement.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/DeclaredStatement.java @@ -10,6 +10,7 @@ package org.opendaylight.yangtools.yang.model.api.meta; import java.util.Collection; import javax.annotation.Nonnull; import javax.annotation.Nullable; + /** * Represents declared statement * @@ -18,7 +19,6 @@ import javax.annotation.Nullable; public interface DeclaredStatement extends ModelStatement { /** - * * Returns statement argument as was present in original source. * * @return statement argument as was present in original source or null, if statement does not take argument. @@ -26,7 +26,6 @@ public interface DeclaredStatement extends ModelStatement { @Nullable String rawArgument(); /** - * * Returns collection of explicitly declared child statements, while preserving its original * ordering from original source. * @@ -34,5 +33,4 @@ public interface DeclaredStatement extends ModelStatement { * source of model. */ @Nonnull Collection> declaredSubstatements(); - } diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/EffectiveStatement.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/EffectiveStatement.java index 2b1e7e052e..e3ef1c5ffe 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/EffectiveStatement.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/EffectiveStatement.java @@ -34,7 +34,6 @@ public interface EffectiveStatement> extends M S getDeclared(); /** - * * Returns value associated with supplied identifier * * @param @@ -48,15 +47,12 @@ public interface EffectiveStatement> extends M * @param identifier * Identifier of element. * @return Value if present, null otherwise. - * - * */ //> V @Nullable > V get(@Nonnull Class namespace,@Nonnull K identifier); /** - * * Returns all local values from supplied namespace. * * @param @@ -73,11 +69,9 @@ public interface EffectiveStatement> extends M > Map getAll(@Nonnull Class namespace); /** + * Returns a collection of all effective substatements. * - * Returns iteration of all effective substatements. - * - * @return iteration of all effective substatements. + * @return collection of all effective substatements. */ - Collection> effectiveSubstatements(); - + @Nonnull Collection> effectiveSubstatements(); } diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/IdentifierNamespace.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/IdentifierNamespace.java index 3a28984882..4f0ed6a369 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/IdentifierNamespace.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/IdentifierNamespace.java @@ -9,8 +9,8 @@ package org.opendaylight.yangtools.yang.model.api.meta; import javax.annotation.Nonnull; import javax.annotation.Nullable; + /** - * * Model specific namespace which allows access to specific * * {@link IdentifierNamespace} serves as common superclass for YANG model @@ -24,14 +24,11 @@ import javax.annotation.Nullable; * @param Value type */ public interface IdentifierNamespace { - /** - * * Returns value associated with supplied identifier * * @param identifier Identifier of value * @return value or null, if identifier is not present in namespace. */ @Nullable V get(@Nonnull K identifier); - } diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/ModelStatement.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/ModelStatement.java index 7d4127b547..6ca3da4819 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/ModelStatement.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/ModelStatement.java @@ -11,7 +11,6 @@ import javax.annotation.Nonnull; import javax.annotation.Nullable; /** - * * Model statement * * There are two base types of model statements: @@ -32,7 +31,6 @@ import javax.annotation.Nullable; * @param Argument type ({@link Void} if statement does not have argument.) */ public interface ModelStatement { - /** * Statement Definition of this statement. * @@ -41,7 +39,6 @@ public interface ModelStatement { @Nonnull StatementDefinition statementDefinition(); /** - * * Returns statement argument * * @return statement argument or null if statement does not have argument. @@ -56,5 +53,4 @@ public interface ModelStatement { * @return statement source. */ @Nonnull StatementSource getStatementSource(); - } diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/StatementDefinition.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/StatementDefinition.java index 2f7fa56720..cfb8488848 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/StatementDefinition.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/StatementDefinition.java @@ -13,7 +13,6 @@ import org.opendaylight.yangtools.concepts.Immutable; import org.opendaylight.yangtools.yang.common.QName; /** - * * Definition / model of YANG {@link DeclaredStatement} and {@link EffectiveStatement}. * * Statement concept is defined in RFC6020 section 6.3: @@ -23,13 +22,9 @@ import org.opendaylight.yangtools.yang.common.QName; * * * Source: - * - * */ public interface StatementDefinition extends Immutable { - /** - * * Returns name of the statement * * @return Name of the statement @@ -38,7 +33,6 @@ public interface StatementDefinition extends Immutable { QName getStatementName(); /** - * * Returns name of statement argument or null, if statement does not have * argument. * @@ -48,7 +42,6 @@ public interface StatementDefinition extends Immutable { QName getArgumentName(); /** - * * Returns class which represents declared version of statement associated * with this definition. * @@ -62,7 +55,6 @@ public interface StatementDefinition extends Immutable { Class> getDeclaredRepresentationClass(); /** - * * Returns class which represents derived behaviour from supplied statement. * * This class should be interface, which defines convenience access to @@ -73,5 +65,4 @@ public interface StatementDefinition extends Immutable { */ @Nonnull Class> getEffectiveRepresentationClass(); - } diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/StatementSource.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/StatementSource.java index 315202fc05..88a42db153 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/StatementSource.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/StatementSource.java @@ -6,33 +6,28 @@ * and is available at http://www.eclipse.org/legal/epl-v10.html */ package org.opendaylight.yangtools.yang.model.api.meta; + /** - * * Origin of statement * * Represents origin of statement - if it was explicitly present * in model representation or if it was inferred from context. - * */ public enum StatementSource { /** - * * Statement was explicitly declared by author * of the supplied model. - * */ DECLARATION, + /** - * * Statement was derived from context of YANG model / statement * and represents effective model. * * Effective context nodes are derived from applicable {@link #DECLARATION} * statements by interpreting their semantic meaning in context * of current statement. - * */ CONTEXT - } diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/package-info.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/package-info.java index d871e3b8a5..f3ef3127a7 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/package-info.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/package-info.java @@ -5,6 +5,7 @@ * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ + /** * Meta model of YANG model as was defined in RFC6020 and extracted by analysis * of YANG text. -- 2.36.6