From 3528dca5dec207aea587b846c2126a6b9bfecaf6 Mon Sep 17 00:00:00 2001 From: Robert Varga Date: Mon, 5 Jun 2017 10:36:36 +0200 Subject: [PATCH] Cleanup checkstyle in yang-{data,model}-api Clean up code and activate enforcement. Change-Id: I66669e0ff80aefa6f3b187337d84efe73b10b320 Signed-off-by: Robert Varga --- yang/yang-data-api/pom.xml | 38 ++++++++++++------- .../yang/data/api/YangInstanceIdentifier.java | 2 + yang/yang-model-api/pom.xml | 26 +++++++++---- .../yang/model/api/ActionDefinition.java | 4 +- .../yang/model/api/ActionNodeContainer.java | 4 +- .../yang/model/api/AnyDataSchemaNode.java | 4 +- .../yang/model/api/AugmentationSchema.java | 14 ++++++- .../yang/model/api/AugmentationTarget.java | 4 +- .../yang/model/api/ChoiceSchemaNode.java | 4 +- .../yang/model/api/ConstraintDefinition.java | 7 ++-- .../yang/model/api/ContainerSchemaNode.java | 3 +- .../yang/model/api/DataNodeContainer.java | 6 ++- .../yang/model/api/DataSchemaNode.java | 13 +++---- .../yang/model/api/DeviateDefinition.java | 14 ++++++- .../yangtools/yang/model/api/DeviateKind.java | 2 + .../yangtools/yang/model/api/Deviation.java | 10 ++++- .../yang/model/api/DocumentedNode.java | 4 +- .../yang/model/api/ExtensionDefinition.java | 6 +-- .../yang/model/api/GroupingDefinition.java | 12 +++--- .../yang/model/api/IdentitySchemaNode.java | 6 +-- .../yang/model/api/ListSchemaNode.java | 5 ++- .../yangtools/yang/model/api/Module.java | 18 +++++---- .../yang/model/api/ModuleIdentifier.java | 3 +- .../yang/model/api/ModuleImport.java | 11 +++++- .../yang/model/api/MustDefinition.java | 1 - .../model/api/NamespaceRevisionAware.java | 1 + .../model/api/NotificationNodeContainer.java | 1 + .../yang/model/api/OperationDefinition.java | 11 +++++- .../yang/model/api/SchemaContext.java | 13 +++---- .../yangtools/yang/model/api/SchemaPath.java | 6 +-- .../yang/model/api/SourceStreamAware.java | 2 + .../yang/model/api/TypeDefinition.java | 2 - .../yang/model/api/UniqueConstraint.java | 1 + .../yang/model/api/UnknownSchemaNode.java | 8 +--- .../yangtools/yang/model/api/UsesNode.java | 8 ++-- .../api/YangModeledAnyXmlSchemaNode.java | 4 +- .../model/api/meta/DeclaredStatement.java | 2 +- .../model/api/meta/EffectiveStatement.java | 2 +- .../model/api/meta/IdentifierNamespace.java | 2 +- .../yang/model/api/meta/ModelStatement.java | 6 +-- .../model/api/meta/StatementDefinition.java | 10 +++-- .../yang/model/api/meta/StatementSource.java | 7 ++-- .../yang/model/api/meta/package-info.java | 13 ++++--- .../yang/model/api/stmt/ActionStatement.java | 3 +- .../api/stmt/ActionStatementContainer.java | 2 +- .../yang/model/api/stmt/AnydataStatement.java | 1 + .../yang/model/api/stmt/CaseStatement.java | 3 +- .../api/stmt/DataDefinitionStatement.java | 5 ++- .../model/api/stmt/IdentityStatement.java | 5 ++- .../model/api/stmt/IfFeatureStatement.java | 3 +- .../model/api/stmt/ModifierStatement.java | 1 + .../model/api/stmt/NotificationStatement.java | 3 +- .../yang/model/api/stmt/OperationGroup.java | 2 +- .../yang/model/api/stmt/RefineStatement.java | 3 +- .../model/api/stmt/SchemaNodeIdentifier.java | 6 +-- .../yang/model/api/stmt/StatusStatement.java | 3 +- .../api/stmt/TypeEffectiveStatement.java | 3 +- .../yang/model/api/stmt/TypeStatement.java | 10 +++-- .../model/api/type/BinaryTypeDefinition.java | 5 +-- .../model/api/type/BitsTypeDefinition.java | 1 - .../model/api/type/DecimalTypeDefinition.java | 5 +-- .../api/type/IdentityTypeDefinition.java | 4 +- .../api/type/IdentityrefTypeDefinition.java | 2 + .../model/api/type/IntegerTypeDefinition.java | 7 ++-- .../yang/model/api/type/ModifierKind.java | 11 ++++-- .../type/UnsignedIntegerTypeDefinition.java | 1 - .../api/MissingSchemaSourceException.java | 4 +- .../repo/api/RevisionSourceIdentifier.java | 8 ++-- .../yang/model/repo/api/SchemaRepository.java | 3 +- .../repo/api/SchemaResolutionException.java | 5 ++- .../repo/api/SchemaSourceRepresentation.java | 10 ++--- .../repo/api/SemVerSourceIdentifier.java | 5 ++- .../yang/model/repo/api/SourceIdentifier.java | 28 ++++++-------- .../model/repo/api/YinDomSchemaSource.java | 7 ++-- .../model/repo/api/YinTextSchemaSource.java | 12 ++---- .../model/repo/spi/PotentialSchemaSource.java | 6 ++- .../model/repo/spi/SchemaSourceProvider.java | 2 + .../repo/spi/SchemaSourceRegistration.java | 3 +- .../model/repo/spi/SchemaSourceRegistry.java | 3 +- 79 files changed, 294 insertions(+), 211 deletions(-) diff --git a/yang/yang-data-api/pom.xml b/yang/yang-data-api/pom.xml index af4b1d13c4..cac2050c10 100644 --- a/yang/yang-data-api/pom.xml +++ b/yang/yang-data-api/pom.xml @@ -68,19 +68,31 @@ - - ${odl.site.url}/${project.groupId}/${stream}/${project.artifactId}/ + + ${odl.site.url}/${project.groupId}/${stream}/${project.artifactId}/ + + + + opendaylight-site + ${nexus.site.url}/${project.artifactId}/ + + diff --git a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/YangInstanceIdentifier.java b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/YangInstanceIdentifier.java index 7ee6cf8a9b..04f4e8afcf 100644 --- a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/YangInstanceIdentifier.java +++ b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/YangInstanceIdentifier.java @@ -548,6 +548,7 @@ public abstract class YangInstanceIdentifier implements Path - - ${odl.site.url}/${project.groupId}/${stream}/${project.artifactId}/ + + ${odl.site.url}/${project.groupId}/${stream}/${project.artifactId}/ diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ActionDefinition.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ActionDefinition.java index 26d6729d1c..3940ee0db6 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ActionDefinition.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ActionDefinition.java @@ -9,11 +9,11 @@ package org.opendaylight.yangtools.yang.model.api; import com.google.common.annotations.Beta; -import java.util.Set; /** - * Represents YANG action statement + * Represents YANG action statement. * + *

* The "action" statement is used to define an operation connected to a * specific container or list data node. It takes one argument, which * is an identifier, followed by a block of substatements that holds diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ActionNodeContainer.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ActionNodeContainer.java index b46df1fb41..6a7929ac74 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ActionNodeContainer.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ActionNodeContainer.java @@ -13,11 +13,10 @@ import com.google.common.collect.ImmutableSet; import java.util.Set; /** - * Node which can contain action nodes + * Node which can contain action nodes. */ @Beta public interface ActionNodeContainer { - /** * All implementations should override this method. * The default definition of this method is used in YANG 1.0 (RFC6020) implementations of @@ -25,6 +24,7 @@ public interface ActionNodeContainer { * which do not allow action statements. * These YANG statements have been changed in YANG 1.1 (RFC7950) and can now contain action statements. * + *

* The default definition is also used by implementations of ContainerSchemaNode which do not support * action statements such as InputEffectiveStatementImpl, OutputEffectiveStatementImpl and SchemaContext. * diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/AnyDataSchemaNode.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/AnyDataSchemaNode.java index 43421a2987..a82b2b4cf6 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/AnyDataSchemaNode.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/AnyDataSchemaNode.java @@ -16,6 +16,7 @@ import javax.annotation.Nullable; * It takes one argument, which is an identifier, followed by a block of * substatements that holds detailed anydata information. * + *

* The "anydata" statement is used to represent an unknown set of nodes * that can be modeled with YANG, except anyxml, but for which the data * model is not known at module design time. It is possible, though not @@ -25,8 +26,9 @@ import javax.annotation.Nullable; */ @Beta public interface AnyDataSchemaNode extends DataSchemaNode { - /** + * Schema of XML data. + * * @return schema of contained XML data or null if it is not provided */ @Nullable ContainerSchemaNode getSchemaOfAnyData(); diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/AugmentationSchema.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/AugmentationSchema.java index 8291c70cea..b68e61a591 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/AugmentationSchema.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/AugmentationSchema.java @@ -17,10 +17,10 @@ import java.util.List; * from a grouping in a "uses" statement. */ public interface AugmentationSchema extends DataNodeContainer, NotificationNodeContainer, ActionNodeContainer { - /** - * Returns when statement + * Returns when statement. * + *

* If when condition is present node defined by the parent data definition * statement is only valid when the returned XPath * expression conceptually evaluates to "true" @@ -32,22 +32,30 @@ public interface AugmentationSchema extends DataNodeContainer, NotificationNodeC RevisionAwareXPath getWhenCondition(); /** + * Returns description text. + * * @return textual description of this augment. */ String getDescription(); /** + * Returns reference text. + * * @return textual cross-reference to an external document that provides * additional information relevant to this node. */ String getReference(); /** + * Returns status of this node. + * * @return actual status of this node. */ Status getStatus(); /** + * Returns augmentation schema path. + * * @return SchemaPath that identifies a node in the schema tree. This node * is called the augment's target node. The target node MUST be * either a container, list, choice, case, input, output, or @@ -57,6 +65,8 @@ public interface AugmentationSchema extends DataNodeContainer, NotificationNodeC SchemaPath getTargetPath(); /** + * Returns unknown schema node children. + * * @return collection of all unknown nodes defined in this augmentation */ List getUnknownSchemaNodes(); diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/AugmentationTarget.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/AugmentationTarget.java index 107a5db65b..d0e664624f 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/AugmentationTarget.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/AugmentationTarget.java @@ -15,10 +15,10 @@ import java.util.Set; * input, output, or notification node. */ public interface AugmentationTarget { - /** + * Returns augmentations targeting this element. + * * @return set of augmentations targeting this element. */ Set getAvailableAugmentations(); - } diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ChoiceSchemaNode.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ChoiceSchemaNode.java index 4c243a9710..0da6676886 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ChoiceSchemaNode.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ChoiceSchemaNode.java @@ -25,7 +25,6 @@ public interface ChoiceSchemaNode extends DataSchemaNode, AugmentationTarget { Set getCases(); /** - * * Returns the concrete case according to specified Q name. * * @param name @@ -46,8 +45,7 @@ public interface ChoiceSchemaNode extends DataSchemaNode, AugmentationTarget { ChoiceCaseNode getCaseNodeByName(String name); /** - * - * Returns name of case which is in the choice specified as default + * Returns name of case which is in the choice specified as default. * * @return string with the name of case which is specified in the argument * of the YANG default substatement of diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ConstraintDefinition.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ConstraintDefinition.java index 30b690df52..6da5c0e116 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ConstraintDefinition.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ConstraintDefinition.java @@ -31,7 +31,6 @@ public interface ConstraintDefinition { * Specifies the rules which the node which contains must YANG * substatement has to match. * - * * @return set of MustDefinition (XPath) instances which * represents the concrete data constraints */ @@ -41,8 +40,8 @@ public interface ConstraintDefinition { * Expreses if the presence of the data element for which this constraint is * specified is|isn't required. * + *

* Contains the value of the mandatory YANG substatement. - * * It is used with YANG statements leaf, choice, anyxml, deviate. * * @return boolean value: @@ -59,9 +58,9 @@ public interface ConstraintDefinition { * Returns the minimum required number of data elements for node where this * constraint is specified. * + *

* The returning value equals to value of the argument of the * min-elements YANG substatement. - * * It is used with YANG statements leaf-list, list, deviate. * * @return integer with minimal number of elements, or null if no minimum is defined @@ -72,9 +71,9 @@ public interface ConstraintDefinition { * Returns the maximum admissible number of data elements for node where * this constraint is specified. * + *

* The returning value equals to value of the argument of the * max-elements YANG substatement. - * * It is used with YANG statements leaf-list, list, deviate. * * @return integer with maximum number of elements, or null if no maximum is defined diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ContainerSchemaNode.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ContainerSchemaNode.java index cd4996e8f9..bb7d8bd5e0 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ContainerSchemaNode.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ContainerSchemaNode.java @@ -15,8 +15,9 @@ package org.opendaylight.yangtools.yang.model.api; */ public interface ContainerSchemaNode extends DataNodeContainer, AugmentationTarget, DataSchemaNode, NotificationNodeContainer, ActionNodeContainer { - /** + * Returns true if this container is marked as presence. + * * @return true, if presence of this container has an explicit meaning, * false otherwise */ diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DataNodeContainer.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DataNodeContainer.java index 872a66ea6b..d07be7d64d 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DataNodeContainer.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DataNodeContainer.java @@ -40,14 +40,18 @@ public interface DataNodeContainer { Set getGroupings(); /** + * Returns the child node corresponding to the specified name. + * * @param name - * QName of seeked child + * QName of child * @return child node of this DataNodeContainer if child with given name is * present, null otherwise */ DataSchemaNode getDataChildByName(QName name); /** + * Returns grouping nodes used ny this container. + * * @return Set of all uses nodes defined within this DataNodeContainer */ Set getUses(); diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DataSchemaNode.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DataSchemaNode.java index c43c340566..4c27eacd47 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DataSchemaNode.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DataSchemaNode.java @@ -8,10 +8,10 @@ package org.opendaylight.yangtools.yang.model.api; /** - * * Data Schema Node represents abstract supertype from which all data tree * definitions are derived. * + *

* Contains the method which are used for getting metadata from the schema nodes * which contains data. * @@ -23,14 +23,11 @@ package org.opendaylight.yangtools.yang.model.api; * @see LeafSchemaNode * @see AnyXmlSchemaNode * @see AnyDataSchemaNode - * - * */ public interface DataSchemaNode extends SchemaNode { - /** * Returns true if the data node was added by augmentation, - * otherwise returns false + * otherwise returns false. * * @return true if the data node was added by augmentation, * otherwise returns false @@ -39,7 +36,7 @@ public interface DataSchemaNode extends SchemaNode { /** * Returns true if the data node was added by uses statement, - * otherwise returns false + * otherwise returns false. * * @return true if the data node was added by uses statement, * otherwise returns false @@ -48,7 +45,7 @@ public interface DataSchemaNode extends SchemaNode { /** * Returns true if the data represents configuration data, - * otherwise returns false + * otherwise returns false. * * @return true if the data represents configuration data, * otherwise returns false @@ -56,7 +53,7 @@ public interface DataSchemaNode extends SchemaNode { boolean isConfiguration(); /** - * Returns the constraints associated with Data Schema Node + * Returns the constraints associated with Data Schema Node. * * @return the constraints associated with Data Schema Node */ diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DeviateDefinition.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DeviateDefinition.java index 7b42318e1a..d77c03b547 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DeviateDefinition.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DeviateDefinition.java @@ -13,70 +13,80 @@ import java.util.Collection; import java.util.Set; /** - * Interface describing YANG 'deviate' statement + * Interface describing YANG 'deviate' statement. * + *

* The 'deviate' statement defines how the device's implementation of * the target node deviates from its original definition. * The argument is one of the strings "not-supported", "add", "replace", or "delete". */ @Beta public interface DeviateDefinition { - /** + * Return deviation kind. * * @return enum which describes the type of this deviate statement */ DeviateKind getDeviateType(); /** + * Returns deviated config value. * * @return value of the deviated config statement or null if it is not deviated */ Boolean getDeviatedConfig(); /** + * Returns deviated default value. * * @return value of the deviated default statement or null if it is not deviated */ String getDeviatedDefault(); /** + * Returns deviated mandatory value. * * @return value of the deviated mandatory statement or null if it is not deviated */ Boolean getDeviatedMandatory(); /** + * Returns deviated max-elements. * * @return value of the deviated max-elements statement or null if it is not deviated */ Integer getDeviatedMaxElements(); /** + * Returns deviated min-elements. * * @return value of the deviated min-elements statement or null if it is not deviated */ Integer getDeviatedMinElements(); /** + * Returns deviated must statements. * * @return set of the deviated must statements */ Set getDeviatedMusts(); /** + * Returns deviated type statement. * * @return deviated type statement or null if it is not deviated */ TypeDefinition getDeviatedType(); /** + * Returns deviated unique statements. * * @return collection of the deviated unique statements */ Collection getDeviatedUniques(); /** + * Returns deviated units statement. * * @return value of the deviated units statement or null if it is not deviated */ diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DeviateKind.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DeviateKind.java index 4fa9d0f28c..30fe1a4c42 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DeviateKind.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DeviateKind.java @@ -26,6 +26,8 @@ public enum DeviateKind { } /** + * Returns the YANG keyword corresponding to this object. + * * @return String that corresponds to the yang keyword. */ public String getKeyword() { diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/Deviation.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/Deviation.java index 75b20b192d..e3d3663f1e 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/Deviation.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/Deviation.java @@ -11,39 +11,47 @@ import java.util.List; /** * Interface describing YANG 'deviation' statement. + * *

* The 'deviation' statement defines a hierarchy of a module that the device * does not implement faithfully. Deviations define the way a device deviate * from a standard. - *

*/ public interface Deviation { /** + * Returns target schema path. + * * @return SchemaPath that identifies the node in the schema tree where a * deviation from the module occurs. */ SchemaPath getTargetPath(); /** + * Returns deviate children. * * @return List of all deviate statements defined in this deviation */ List getDeviates(); /** + * Returns the description text. * * @return textual description of this deviation */ String getDescription(); /** + * Returns reference. + * * @return textual cross-reference to an external document that provides * additional information relevant to this node. */ String getReference(); /** + * Returns unknown schema node children. + * * @return collection of all unknown nodes defined under this schema node. */ List getUnknownSchemaNodes(); diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DocumentedNode.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DocumentedNode.java index 353a817c37..c375e02889 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DocumentedNode.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DocumentedNode.java @@ -16,7 +16,6 @@ import javax.annotation.Nullable; * Node which can have documentation assigned. */ public interface DocumentedNode { - /** * All implementations should override this method. * The default definition of this method is used only in YANG 1.0 (RFC6020) implementations of @@ -53,9 +52,8 @@ public interface DocumentedNode { } interface WithStatus extends DocumentedNode { - /** - * Returns status of the instance of the type SchemaNode + * Returns status of the instance of the type SchemaNode. * * @return status of this node which represents the argument of the YANG * status substatement diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ExtensionDefinition.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ExtensionDefinition.java index edeb389cc4..965ae9339f 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ExtensionDefinition.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ExtensionDefinition.java @@ -8,13 +8,10 @@ package org.opendaylight.yangtools.yang.model.api; /** - * * Contains the methods for getting the data which are part of the YANG * extensoion statement. - * */ public interface ExtensionDefinition extends SchemaNode { - /** * Returns the String that is the name of argument to the * Keyword. If no argument statement is present the method will return @@ -36,8 +33,7 @@ public interface ExtensionDefinition extends SchemaNode { * yin-element statement the return value is by default set to * false * - *
- *
+ *

* For more specific definition please look into [RFC-6020] * The yin-element Statement diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/GroupingDefinition.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/GroupingDefinition.java index 629fad57e7..16318910e9 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/GroupingDefinition.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/GroupingDefinition.java @@ -9,21 +9,19 @@ package org.opendaylight.yangtools.yang.model.api; /** * Interface describing YANG 'grouping' statement. + * *

* It is used to define a reusable block of nodes, which may be used locally in - * the module, in modules that include it, and by other modules that import from - * it. - *

+ * the module, in modules that include it, and by other modules that import from it. */ -public interface GroupingDefinition extends DataNodeContainer, SchemaNode, NotificationNodeContainer, ActionNodeContainer { - +public interface GroupingDefinition extends DataNodeContainer, SchemaNode, NotificationNodeContainer, + ActionNodeContainer { /** * Returns true if the data node was added by uses statement, - * otherwise returns false + * otherwise returns false. * * @return true if the data node was added by uses statement, * otherwise returns false */ boolean isAddedByUses(); - } diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/IdentitySchemaNode.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/IdentitySchemaNode.java index 216361d284..be0fbd08fd 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/IdentitySchemaNode.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/IdentitySchemaNode.java @@ -13,17 +13,17 @@ import javax.annotation.Nonnull; /** * Interface describing YANG 'identity' statement. + * *

* The 'identity' statement is used to define a new globally unique, abstract, * and untyped identity. Its only purpose is to denote its name, semantics, and * existence. The built-in datatype "identityref" can be used to reference * identities within a data model. - *

*/ public interface IdentitySchemaNode extends SchemaNode { - /** - * @deprecated use {@link #getBaseIdentities()} instead + * Return the base identity. + * @deprecated use {@link #getBaseIdentities()} instead. * * @return an existing identity, from which the new identity is derived or * null, if the identity is defined from scratch. diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ListSchemaNode.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ListSchemaNode.java index 217b4a2f16..fa73cc4111 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ListSchemaNode.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ListSchemaNode.java @@ -23,8 +23,9 @@ import org.opendaylight.yangtools.yang.common.QName; */ public interface ListSchemaNode extends DataNodeContainer, AugmentationTarget, DataSchemaNode, NotificationNodeContainer, ActionNodeContainer { - /** + * Returns the list of leaf identifiers. + * * @return List of QNames of leaf identifiers of this list */ List getKeyDefinition(); @@ -39,6 +40,8 @@ public interface ListSchemaNode extends DataNodeContainer, AugmentationTarget, D boolean isUserOrdered(); /** + * Returns unique constraints. + * * @return Collection of unique constraints of this list schema node */ @Nonnull diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/Module.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/Module.java index d64a4de98c..d97e76134c 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/Module.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/Module.java @@ -28,8 +28,10 @@ import org.opendaylight.yangtools.concepts.SemVer;   {@link #getDescription() description} "description test";
  {@link #getReference() reference} "reference test";

-   {@link #getOrganization() organization} "John Doe, john.doe@email.com";
-   {@link #getContact() contact} "http://www.opendaylight.org/";

+   {@link #getOrganization() organization} + "John Doe, john.doe@email.com";
+   {@link #getContact() contact} "http://www.opendaylight.org/";
+
  {@link #getFeatures() feature} feature-test{
     description "description of some feature";
@@ -66,7 +68,7 @@ public interface Module extends DataNodeContainer, SourceStreamAware, ModuleIden SemVer DEFAULT_SEMANTIC_VERSION = SemVer.create(0, 0, 0); /** - * Returns the prefix of the module + * Returns the prefix of the module. * * @return string with the module prefix which is specified as argument of * YANG {@link Module prefix} @@ -75,9 +77,7 @@ public interface Module extends DataNodeContainer, SourceStreamAware, ModuleIden String getPrefix(); /** - * Returns the YANG version. - * - * Default value is 1. + * Returns the YANG version. Default value is 1. * * @return string with the module YANG version which is specified as * argument of YANG {@link Module * The contact represents the person or persons to whom technical queries * concerning this module should be sent, such as their name, postal * address, telephone number, and electronic mail address. @@ -142,6 +143,7 @@ public interface Module extends DataNodeContainer, SourceStreamAware, ModuleIden * Returns FeatureDefinition instances which contain data from * feature statements defined in the module. * + *

* The feature is used to define a mechanism by which portions of the schema * are marked as conditional. * @@ -215,8 +217,8 @@ public interface Module extends DataNodeContainer, SourceStreamAware, ModuleIden * Get YANG source. * * @return YANG text of this module, or null if the source is not available. - * @deprecated Use {@link org.opendaylight.yangtools.yang.model.repo.api.SchemaRepository#getSchemaSource(org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier, Class)} - * instead. + * @deprecated Use {@link org.opendaylight.yangtools.yang.model.repo.api.SchemaRepository#getSchemaSource( + * org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier, Class)} instead. */ @Deprecated @Nullable String getSource(); diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ModuleIdentifier.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ModuleIdentifier.java index 6afd21a3d5..fac4b62b4c 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ModuleIdentifier.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ModuleIdentifier.java @@ -25,7 +25,7 @@ public interface ModuleIdentifier { /** * Returns the name of the module which is specified as argument of YANG - * {@link Module module} keyword + * {@link Module module} keyword. * * @return string with the name of the module */ @@ -57,6 +57,7 @@ public interface ModuleIdentifier { /** * Returns the semantic version of yang module. * + *

* If the semantic version is not specified, default semantic version of * module is returned. * diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ModuleImport.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ModuleImport.java index d352aeacbe..04330e12b9 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ModuleImport.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ModuleImport.java @@ -12,24 +12,29 @@ import org.opendaylight.yangtools.concepts.SemVer; /** * Interface describing YANG 'import' statement. + * *

* The import statement makes definitions from one module available inside * another module or submodule. - *

*/ public interface ModuleImport extends DocumentedNode { - /** + * Returns the name of the module to import. + * * @return Name of the module to import */ String getModuleName(); /** + * Returns the module revision to import. May be null. + * * @return Revision of module to import */ Date getRevision(); /** + * Returns the semantic version to import. + * * @return Semantic version of module to import */ default SemVer getSemanticVersion() { @@ -37,6 +42,8 @@ public interface ModuleImport extends DocumentedNode { } /** + * Returns the prefix associated with the imported module. + * * @return Prefix used to point to imported module */ String getPrefix(); diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/MustDefinition.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/MustDefinition.java index 99072c8a29..9d3480e992 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/MustDefinition.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/MustDefinition.java @@ -8,7 +8,6 @@ package org.opendaylight.yangtools.yang.model.api; /** - * * Contains methods for accessing constraint declaration for valid data in form * of XPath expressions.
*
diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/NamespaceRevisionAware.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/NamespaceRevisionAware.java index 8d0dd54d9f..479720620b 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/NamespaceRevisionAware.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/NamespaceRevisionAware.java @@ -13,5 +13,6 @@ import java.util.Date; public interface NamespaceRevisionAware { URI getNamespace(); + Date getRevision(); } diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/NotificationNodeContainer.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/NotificationNodeContainer.java index 4ec3479602..8a9c20bb4d 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/NotificationNodeContainer.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/NotificationNodeContainer.java @@ -21,6 +21,7 @@ public interface NotificationNodeContainer { * which do not allow notification statements. * These YANG statements have been changed in YANG 1.1 (RFC7950) and can now contain notification statements. * + *

* The default definition is also used by implementations of ContainerSchemaNode which do not support * notification statements such as InputEffectiveStatementImpl and OutputEffectiveStatementImpl. * diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/OperationDefinition.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/OperationDefinition.java index 94ecd0a7c0..4f285d85fe 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/OperationDefinition.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/OperationDefinition.java @@ -12,28 +12,35 @@ import com.google.common.annotations.Beta; import java.util.Set; /** - * Common interface for an operation + * Common interface for an operation. */ @Beta public interface OperationDefinition extends SchemaNode { - /** + * Returns the set of type definitions declared under this operation. + * * @return Set of type definitions declared under this operation. */ Set> getTypeDefinitions(); /** + * Returns the set of grouping statements declared under this operation. + * * @return Set of grouping statements declared under this operation. */ Set getGroupings(); /** + * Returns definition of input parameters for this operation. + * * @return Definition of input parameters for this operation. * The substatements of input define nodes under the operation's input node. */ ContainerSchemaNode getInput(); /** + * Returns definition of output parameters for this operation. + * * @return Definition of output parameters for this operation. The * substatements of output define nodes under the operation's output node. */ diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SchemaContext.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SchemaContext.java index 770a584125..ead8fc7bee 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SchemaContext.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SchemaContext.java @@ -57,7 +57,7 @@ public interface SchemaContext extends ContainerSchemaNode { /** * Returns extencion definition instances which are defined as the direct - * subelements in all YANG modules in the context + * subelements in all YANG modules in the context. * * @return set of ExtensionDefinition instances which * represents nodes defined via extension YANG keyword @@ -81,7 +81,6 @@ public interface SchemaContext extends ContainerSchemaNode { Module findModuleByName(final String name, final Date revision); /** - * * Returns module instance (from the context) with concrete namespace. * * @param namespace @@ -97,8 +96,8 @@ public interface SchemaContext extends ContainerSchemaNode { * Returns module instance based on given namespace and revision. If * revision is not specified, returns module with newest revision. * - * @param namespace - * @param revision + * @param namespace Module namespace, may be null + * @param revision Module revision, may be null * @return Matching module or null if a match is not found */ default Module findModuleByNamespaceAndRevision(final URI namespace, final Date revision) { @@ -116,9 +115,10 @@ public interface SchemaContext extends ContainerSchemaNode { /** * Get yang source code represented as string for matching * {@link org.opendaylight.yangtools.yang.model.api.ModuleIdentifier}. + * * @param moduleIdentifier must provide a non-null - * {@link org.opendaylight.yangtools.yang.model.api.ModuleIdentifier#getName()}, - * other methods might return null. + * {@link org.opendaylight.yangtools.yang.model.api.ModuleIdentifier#getName()}, other methods might return + * null. * @return value iif matching module is found in schema context. */ Optional getModuleSource(ModuleIdentifier moduleIdentifier); @@ -127,5 +127,4 @@ public interface SchemaContext extends ContainerSchemaNode { * Get all module and submodule identifiers. */ Set getAllModuleIdentifiers(); - } diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SchemaPath.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SchemaPath.java index f894fc9b93..a7afe1b4ac 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SchemaPath.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SchemaPath.java @@ -105,12 +105,12 @@ public abstract class SchemaPath implements Immutable { this.parent = parent; this.qname = qname; - int h = Objects.hashCode(parent); + int tmp = Objects.hashCode(parent); if (qname != null) { - h = h * 31 + qname.hashCode(); + tmp = tmp * 31 + qname.hashCode(); } - hash = h; + hash = tmp; } private ImmutableList getLegacyPath() { diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SourceStreamAware.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SourceStreamAware.java index f11f65ac3a..9a5217d081 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SourceStreamAware.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SourceStreamAware.java @@ -8,6 +8,8 @@ package org.opendaylight.yangtools.yang.model.api; /** + * Allows access to module source. + * * @deprecated This interface is a violation of the effective model contract. To look up the source of a particular * module use a {@link org.opendaylight.yangtools.yang.model.repo.api.SchemaRepository} or a similar * lookup table. diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/TypeDefinition.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/TypeDefinition.java index 8290e22622..53ec6ac3e1 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/TypeDefinition.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/TypeDefinition.java @@ -8,7 +8,6 @@ package org.opendaylight.yangtools.yang.model.api; /** - * * YANG statement typedef contains also substatements *

    *
  • default - default value which is compatible with @@ -26,7 +25,6 @@ package org.opendaylight.yangtools.yang.model.api; * is included in the instance of this type */ public interface TypeDefinition> extends SchemaNode { - /** * Returns the base type from which this type is derived. If this is yang * built-in type, returns null. diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/UniqueConstraint.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/UniqueConstraint.java index 009d25ad77..101317a439 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/UniqueConstraint.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/UniqueConstraint.java @@ -15,6 +15,7 @@ import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Relat /** * Interface describing YANG 'unique' constraint. * + *

    * The 'unique' constraint specifies that the combined values of all the leaf * instances specified in the argument string, including leafs with default * values, MUST be unique within all list entry instances in which all diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/UnknownSchemaNode.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/UnknownSchemaNode.java index 136ee89701..cd9fb7ad27 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/UnknownSchemaNode.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/UnknownSchemaNode.java @@ -10,12 +10,9 @@ package org.opendaylight.yangtools.yang.model.api; import org.opendaylight.yangtools.yang.common.QName; /** - * * Contains the methods for getting the details about the unknown node. - * */ public interface UnknownSchemaNode extends SchemaNode { - /** * Returns QName instance with the name of the unknown node. * @@ -31,7 +28,6 @@ public interface UnknownSchemaNode extends SchemaNode { String getNodeParameter(); /** - * * Describes whether the node was added through uses YANG * keyword. * @@ -41,7 +37,6 @@ public interface UnknownSchemaNode extends SchemaNode { boolean isAddedByUses(); /** - * * Describes whether the node was added through augment YANG * statement. * @@ -51,10 +46,9 @@ public interface UnknownSchemaNode extends SchemaNode { boolean isAddedByAugmentation(); /** - * Get extension definition which identifies this node + * Get extension definition which identifies this node. * * @return extension definition if exists, null otherwise */ ExtensionDefinition getExtensionDefinition(); - } diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/UsesNode.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/UsesNode.java index 86acdf68e4..de724a2da3 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/UsesNode.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/UsesNode.java @@ -26,7 +26,6 @@ public interface UsesNode extends DocumentedNode.WithStatus { @Nonnull SchemaPath getGroupingPath(); /** - * * Returns augmentations which were specified in this uses node. * * @return Set of augment statements defined under this uses node @@ -35,7 +34,7 @@ public interface UsesNode extends DocumentedNode.WithStatus { /** * Returns true if the data node was added by augmentation, - * otherwise returns false + * otherwise returns false. * * @return true if the data node was added by augmentation, * otherwise returns false @@ -44,7 +43,7 @@ public interface UsesNode extends DocumentedNode.WithStatus { /** * Returns true if the data node was added by uses statement, - * otherwise returns false + * otherwise returns false. * * @return true if the data node was added by uses statement, * otherwise returns false @@ -61,8 +60,9 @@ public interface UsesNode extends DocumentedNode.WithStatus { @Nonnull Map getRefines(); /** - * Returns when statement + * Returns when statement. * + *

    * If when condition is present node defined by the parent data definition * statement is only valid when the returned XPath expression conceptually * evaluates to "true" for a particular instance, then the node defined by diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/YangModeledAnyXmlSchemaNode.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/YangModeledAnyXmlSchemaNode.java index e1119dee04..3fb10096b3 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/YangModeledAnyXmlSchemaNode.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/YangModeledAnyXmlSchemaNode.java @@ -21,13 +21,13 @@ import javax.annotation.Nonnull; * This interface was modeled according to definition in [RFC-6020] The anyxml * Statement - * - * */ @Beta public interface YangModeledAnyXmlSchemaNode extends AnyXmlSchemaNode { /** + * Returns the root schema node of the data in this anyxml node. + * * @return DataSchemaNode - schema of contained XML data */ @Nonnull 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 54d83326a9..6be9484442 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 @@ -12,7 +12,7 @@ import javax.annotation.Nonnull; import javax.annotation.Nullable; /** - * Represents declared statement + * Represents declared statement. * * @param Argument type ({@link Void} if statement does not have argument.) */ 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 e3ef1c5ffe..1900d6bcc6 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,7 @@ public interface EffectiveStatement> extends M S getDeclared(); /** - * Returns value associated with supplied identifier + * Returns value associated with supplied identifier. * * @param * Identifier type 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 4f0ed6a369..f06850b27b 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 @@ -25,7 +25,7 @@ import javax.annotation.Nullable; */ public interface IdentifierNamespace { /** - * Returns value associated with supplied identifier + * Returns value associated with supplied identifier. * * @param identifier Identifier of value * @return value or null, if identifier is not present in namespace. 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 6ca3da4819..6dae109fb1 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,9 +11,7 @@ import javax.annotation.Nonnull; import javax.annotation.Nullable; /** - * Model statement - * - * There are two base types of model statements: + * Model statement. There are two base types of model statements: *

      *
    • {@link DeclaredStatement} - Statement representation as was defined in original * source. This representation could be used during computation of effective model @@ -39,7 +37,7 @@ public interface ModelStatement { @Nonnull StatementDefinition statementDefinition(); /** - * Returns statement argument + * Returns statement argument. * * @return statement argument or null if statement does not have argument. */ 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 ac2293d165..a91dd7eeb4 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,18 +13,19 @@ import org.opendaylight.yangtools.concepts.Immutable; import org.opendaylight.yangtools.yang.common.QName; /** - * Definition / model of YANG {@link DeclaredStatement} and - * {@link EffectiveStatement}. + * Definition / model of YANG {@link DeclaredStatement} and {@link EffectiveStatement}. * + *

      * Statement concept is defined in RFC6020 section 6.3:

      A YANG * module contains a sequence of statements. Each statement starts with a * keyword, followed by zero or one argument
      * + *

      * Source: */ public interface StatementDefinition extends Immutable { /** - * Returns name of the statement + * Returns name of the statement. * * @return Name of the statement */ @@ -44,6 +45,7 @@ public interface StatementDefinition extends Immutable { * Returns class which represents declared version of statement associated * with this definition. * + *

      * This class should be interface, which provides convenience access to * declared substatements. * @@ -56,6 +58,7 @@ public interface StatementDefinition extends Immutable { /** * Returns class which represents derived behaviour from supplied statement. * + *

      * This class should be interface, which defines convenience access to * statement properties, namespace items and substatements. * @@ -70,7 +73,6 @@ public interface StatementDefinition extends Immutable { * element. If argument of statement is represented as argument of yin * element, returns false. * - * * @return returns true, if statement argument is represented as value of * yin element, otherwise returns false. */ 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 88a42db153..2752b3c3d2 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 @@ -8,16 +8,14 @@ package org.opendaylight.yangtools.yang.model.api.meta; /** - * Origin of statement - * + * 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. + * Statement was explicitly declared by author of the supplied model. */ DECLARATION, @@ -25,6 +23,7 @@ public enum StatementSource { * 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. 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 f3ef3127a7..9f2b9006f4 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 @@ -18,9 +18,10 @@ * YANG source is defined as sequence of statement in * RFC6020, Section 6.3. * this model is also correct for YIN, which is XML serialisation of YANG source. + * *

      - * Statements are represented as instances / subclasses of {@link org.opendaylight.yangtools.yang.model.api.meta.ModelStatement} - * concept and its two subconcepts which are: + * Statements are represented as instances / subclasses of + * {@link org.opendaylight.yangtools.yang.model.api.meta.ModelStatement} concept and its two subconcepts which are: *

        *
      • * {@link org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement} - this contains navigable @@ -32,6 +33,7 @@ * present in YANG specification and/or was introduced in form of extensions. *
        • *
      + * *

      * Clear separation of declared / effective model is needed, since statement definition also * contains information how effective model is computed and there is no one to one mapping @@ -41,9 +43,10 @@ *

      Identifiers and Namespaces

      * Effective model of YANG has several identifier types and namespaces, which behaves differently * and are mostly used during processing data and/or during computing effective (semantic) model. + * *

      - * Common abstraction for various types of namespaces is {@link org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace} + * Common abstraction for various types of namespaces is + * {@link org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace} * from which concrete effective model namespaces are derived. - * */ -package org.opendaylight.yangtools.yang.model.api.meta; \ No newline at end of file +package org.opendaylight.yangtools.yang.model.api.meta; diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/ActionStatement.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/ActionStatement.java index 25d9f8c241..916539b351 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/ActionStatement.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/ActionStatement.java @@ -13,8 +13,9 @@ import org.opendaylight.yangtools.yang.common.QName; import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement; /** - * Represents YANG action statement + * Represents YANG action statement. * + *

      * The "action" statement is used to define an operation connected to a * specific container or list data node. It takes one argument, which * is an identifier, followed by a block of substatements that holds diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/ActionStatementContainer.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/ActionStatementContainer.java index 0eef832b56..3c0a1c1935 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/ActionStatementContainer.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/ActionStatementContainer.java @@ -14,7 +14,7 @@ import java.util.Collection; import javax.annotation.Nonnull; /** - * Statement which can contain action statements + * Statement which can contain action statements. */ @Beta public interface ActionStatementContainer { diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/AnydataStatement.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/AnydataStatement.java index d89fe68ae8..0de93744dc 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/AnydataStatement.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/AnydataStatement.java @@ -18,6 +18,7 @@ import javax.annotation.Nullable; * It takes one argument, which is an identifier, followed by a block of * substatements that holds detailed anydata information. * + *

      * The "anydata" statement is used to represent an unknown set of nodes * that can be modeled with YANG, except anyxml, but for which the data * model is not known at module design time. It is possible, though not diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/CaseStatement.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/CaseStatement.java index b6b795c1d7..aaa008ea9a 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/CaseStatement.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/CaseStatement.java @@ -11,7 +11,8 @@ import javax.annotation.Nonnull; import org.opendaylight.yangtools.yang.common.QName; import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement; -public interface CaseStatement extends DeclaredStatement, DataDefinitionContainer, DocumentationGroup.WithStatus, ConditionalDataDefinition { +public interface CaseStatement extends DeclaredStatement, DataDefinitionContainer, + DocumentationGroup.WithStatus, ConditionalDataDefinition { @Nonnull QName getName(); } diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/DataDefinitionStatement.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/DataDefinitionStatement.java index da49cb196a..8e70fefd5f 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/DataDefinitionStatement.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/DataDefinitionStatement.java @@ -13,14 +13,15 @@ import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement; /** * Statement that defines new data nodes. - * * One of container, leaf, leaf-list, list, choice, case, * augment, uses, anyxml and anydata. * + *

      * Defined in: RFC6020, Section 3 */ @Rfc6020AbnfRule("data-def-stmt") -public interface DataDefinitionStatement extends DeclaredStatement, DocumentationGroup.WithStatus, ConditionalDataDefinition { +public interface DataDefinitionStatement extends DeclaredStatement, DocumentationGroup.WithStatus, + ConditionalDataDefinition { @Nonnull QName getName(); } diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/IdentityStatement.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/IdentityStatement.java index 88eef17b63..f94506306b 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/IdentityStatement.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/IdentityStatement.java @@ -19,11 +19,14 @@ public interface IdentityStatement extends DeclaredStatement, Documentati @Nonnull QName getName(); /** + * Returns the base identity. * @deprecated use {@link #getBases()} instead * * @return base statement */ - @Deprecated @Nullable BaseStatement getBase(); + @Deprecated + @Nullable + BaseStatement getBase(); // FIXME: version 2.0.0: make this method non-default @Nonnull default Collection getBases() { diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/IfFeatureStatement.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/IfFeatureStatement.java index a2284e5e73..7b1abd53f3 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/IfFeatureStatement.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/IfFeatureStatement.java @@ -16,7 +16,6 @@ import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement; /** * Represents YANG if-feature statement. - * * The "if-feature" statement makes its parent statement conditional. */ public interface IfFeatureStatement extends DeclaredStatement>> { @@ -31,4 +30,4 @@ public interface IfFeatureStatement extends DeclaredStatement> getIfFeaturePredicate(); -} \ No newline at end of file +} diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/ModifierStatement.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/ModifierStatement.java index de6831fb75..0d04ee2a52 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/ModifierStatement.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/ModifierStatement.java @@ -16,6 +16,7 @@ import org.opendaylight.yangtools.yang.model.api.type.ModifierKind; /** * Represents YANG modifier statement. * + *

      * The "modifier" statement, which is an optional substatement * to the "pattern" statement, takes as an argument the string "invert-match". * If a pattern has the "invert-match" modifier present, the type is diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/NotificationStatement.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/NotificationStatement.java index 3d25d7c955..c27342e4f9 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/NotificationStatement.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/NotificationStatement.java @@ -13,7 +13,8 @@ import javax.annotation.Nonnull; import org.opendaylight.yangtools.yang.common.QName; import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement; -public interface NotificationStatement extends DeclaredStatement, DataDefinitionContainer.WithReusableDefinitions, DocumentationGroup.WithStatus { +public interface NotificationStatement extends DeclaredStatement, + DataDefinitionContainer.WithReusableDefinitions, DocumentationGroup.WithStatus { @Nonnull QName getName(); diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/OperationGroup.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/OperationGroup.java index 4595c7b039..a17004f246 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/OperationGroup.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/OperationGroup.java @@ -14,7 +14,7 @@ import javax.annotation.Nonnull; import org.opendaylight.yangtools.yang.common.QName; /** - * Common interface for action and rpc statements + * Common interface for action and rpc statements. */ @Beta public interface OperationGroup extends DocumentationGroup.WithStatus { diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/RefineStatement.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/RefineStatement.java index bf268074e2..da8be7f714 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/RefineStatement.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/RefineStatement.java @@ -12,7 +12,8 @@ import javax.annotation.Nonnull; import javax.annotation.Nullable; import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement; -public interface RefineStatement extends DeclaredStatement, DocumentationGroup, ConditionalFeature { +public interface RefineStatement extends DeclaredStatement, DocumentationGroup, + ConditionalFeature { String getTargetNode(); interface RefineContainerStatement extends RefineStatement { diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/SchemaNodeIdentifier.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/SchemaNodeIdentifier.java index 4a62363007..12f8ec04f8 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/SchemaNodeIdentifier.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/SchemaNodeIdentifier.java @@ -109,12 +109,12 @@ public abstract class SchemaNodeIdentifier implements Immutable { this.parent = parent; this.qname = qname; - int h = Objects.hashCode(parent); + int tmp = Objects.hashCode(parent); if (qname != null) { - h = h * 31 + qname.hashCode(); + tmp = tmp * 31 + qname.hashCode(); } - hash = h; + hash = tmp; } private ImmutableList getLegacyPath() { diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/StatusStatement.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/StatusStatement.java index 5b9a023357..8ed3c23eaf 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/StatusStatement.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/StatusStatement.java @@ -7,9 +7,8 @@ */ package org.opendaylight.yangtools.yang.model.api.stmt; -import org.opendaylight.yangtools.yang.model.api.Status; - import javax.annotation.Nonnull; +import org.opendaylight.yangtools.yang.model.api.Status; import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement; public interface StatusStatement extends DeclaredStatement { diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/TypeEffectiveStatement.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/TypeEffectiveStatement.java index 0502988989..3b5288501a 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/TypeEffectiveStatement.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/TypeEffectiveStatement.java @@ -9,6 +9,7 @@ package org.opendaylight.yangtools.yang.model.api.stmt; import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement; -public interface TypeEffectiveStatement extends EffectiveStatement, TypeDefinitionAware { +public interface TypeEffectiveStatement extends EffectiveStatement, + TypeDefinitionAware { } diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/TypeStatement.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/TypeStatement.java index 532d2e260c..7d18f8f40c 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/TypeStatement.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/TypeStatement.java @@ -74,15 +74,19 @@ public interface TypeStatement extends DeclaredStatement { interface IdentityRefSpecification extends TypeStatement { /** + * Returns the base identity. * @deprecated use {@link #getBases()} instead * * @return base statement */ - @Deprecated @Nonnull BaseStatement getBase(); + @Deprecated + @Nonnull BaseStatement getBase(); /** - * @return collection of base statements (in YANG 1.1 models) or a collection containing just one base statement - * (in YANG 1.0 models) + * Returns the base statements. + * + * @return collection of base statements (in YANG 1.1 models) or a collection containing just one base + * statement (in YANG 1.0 models) */ @Nonnull Collection getBases(); } diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/BinaryTypeDefinition.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/BinaryTypeDefinition.java index 94eca2b9e4..9196a286d8 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/BinaryTypeDefinition.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/BinaryTypeDefinition.java @@ -26,10 +26,9 @@ import org.opendaylight.yangtools.yang.model.api.TypeDefinition; * Built-In Type */ public interface BinaryTypeDefinition extends TypeDefinition { - /** - * Returns List of number of octets that binary value contains. These are the effective constraints, e.g. they include - * any range constraints imposed by base types. + * Returns List of number of octets that binary value contains. These are the effective constraints, e.g. they + * include any range constraints imposed by base types. * * @return List of number of octets that binary value contains. * diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/BitsTypeDefinition.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/BitsTypeDefinition.java index bbaa5c23ef..8301c6272c 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/BitsTypeDefinition.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/BitsTypeDefinition.java @@ -25,7 +25,6 @@ public interface BitsTypeDefinition extends TypeDefinition { @Nonnull List getBits(); /** - * * Contains the methods for accessing the data about the individual bit of * bits YANG type. */ diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/DecimalTypeDefinition.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/DecimalTypeDefinition.java index 75f6f43444..d0566d48cf 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/DecimalTypeDefinition.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/DecimalTypeDefinition.java @@ -16,7 +16,6 @@ import org.opendaylight.yangtools.yang.model.api.TypeDefinition; * substatement for decimal64 built-in type. */ public interface DecimalTypeDefinition extends TypeDefinition { - /** * Returns range constraints for instance of this type. * @@ -27,9 +26,9 @@ public interface DecimalTypeDefinition extends TypeDefinition getRangeConstraints(); /** - * Returns integer between 1 and 18 inclusively.
      - *
      + * Returns integer between 1 and 18 inclusively. * + *

      * The "fraction-digits" statement controls the size of the minimum * difference between values of a decimal64 type, by restricting the value * space to numbers that are expressible as "i x 10^-n" where n is the diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/IdentityTypeDefinition.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/IdentityTypeDefinition.java index b11a085194..e5696bb5ac 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/IdentityTypeDefinition.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/IdentityTypeDefinition.java @@ -11,13 +11,11 @@ import org.opendaylight.yangtools.yang.common.QName; import org.opendaylight.yangtools.yang.model.api.TypeDefinition; /** - * * Contains the method for getting the details about YANG identity. */ public interface IdentityTypeDefinition extends TypeDefinition { - /** - * Returns the name of the YANG identity + * Returns the name of the YANG identity. * * @return QName of the YANG identity */ diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/IdentityrefTypeDefinition.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/IdentityrefTypeDefinition.java index 43e8d3384f..e4337d8539 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/IdentityrefTypeDefinition.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/IdentityrefTypeDefinition.java @@ -29,6 +29,8 @@ public interface IdentityrefTypeDefinition extends TypeDefinition - * The integer built-in types in Yang are int8, int16, int32, int64. They represent signed integers of different sizes:
      + * IntegerTypeDefinition is interface which represents SIGNED Integer values defined in Yang language.
      + * The integer built-in types in Yang are int8, int16, int32, int64. They represent signed integers of different + * sizes:
      *

        *
      • int8 represents integer values between -128 and 127, inclusively.
        • *
      • int16 represents integer values between -32768 and 32767, inclusively.
        • @@ -21,10 +22,10 @@ import org.opendaylight.yangtools.yang.model.api.TypeDefinition; *
      • int64 represents integer values between -9223372036854775808 and 9223372036854775807, inclusively.
        • *
      * + *

      * The Integer Built-In Types are defined in [RFC-6020] */ public interface IntegerTypeDefinition extends TypeDefinition { - /** * Returns Range Constraints defined for given Integer Type. These are the effective constraints, e.g. they include * any range constraints imposed by base types. diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/ModifierKind.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/ModifierKind.java index f83f46b489..435b400c2f 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/ModifierKind.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/ModifierKind.java @@ -18,6 +18,7 @@ import javax.annotation.Nonnull; /** * Enum describing the effect of a YANG modifier statement. * + *

      * As of YANG 1.1 (RFC7950) there is only one modifier value available and that * is "invert-match". If there are more possible values added in the future, * this enum can be extended with more enum constants. @@ -30,23 +31,25 @@ public enum ModifierKind { private final String keyword; - private ModifierKind(final String keyword) { + ModifierKind(final String keyword) { this.keyword = Preconditions.checkNotNull(keyword); } /** - * @return String that corresponds to the yang keyword. + * YANG keyword of this modifier. + * + * @return String that corresponds to the YANG keyword. */ public @Nonnull String getKeyword() { return keyword; } /** - * Returns ModifierKind based on supplied Yang keyword + * Returns ModifierKind based on supplied Yang keyword. * * @param keyword * Yang keyword in string form - * @return ModifierKind based on supplied Yang keyword + * @return ModifierKind based on supplied YANG keyword * @throws NullPointerException if keyword is null */ public static Optional parse(final String keyword) { diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/UnsignedIntegerTypeDefinition.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/UnsignedIntegerTypeDefinition.java index 20c04acc95..7b81e45e51 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/UnsignedIntegerTypeDefinition.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/UnsignedIntegerTypeDefinition.java @@ -13,7 +13,6 @@ import org.opendaylight.yangtools.yang.model.api.TypeDefinition; /** * Contains the method for getting detail data about unsigned integer. - * * Specifically it is the method for getting the range value. */ public interface UnsignedIntegerTypeDefinition extends TypeDefinition { diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/MissingSchemaSourceException.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/MissingSchemaSourceException.java index 2062a63551..21b795bd40 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/MissingSchemaSourceException.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/MissingSchemaSourceException.java @@ -23,8 +23,8 @@ public class MissingSchemaSourceException extends SchemaSourceException { this(message, id, null); } - public MissingSchemaSourceException(final String s, final SourceIdentifier id, final Throwable t) { - super(s, t); + public MissingSchemaSourceException(final String message, final SourceIdentifier id, final Throwable cause) { + super(message, cause); this.id = Preconditions.checkNotNull(id); } diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/RevisionSourceIdentifier.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/RevisionSourceIdentifier.java index 5ec07d04ef..6fc229ecbc 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/RevisionSourceIdentifier.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/RevisionSourceIdentifier.java @@ -13,8 +13,9 @@ import com.google.common.base.Preconditions; import java.util.Objects; /** - * YANG Schema revision source identifier + * YANG Schema revision source identifier. * + *

      * Simple transfer object represents revision identifier of source for YANG * schema (module or submodule), which consists of *

        @@ -22,10 +23,12 @@ import java.util.Objects; *
      • Module revision (optional) ({link {@link #getRevision()}) *
      * + *

      * Revision source identifier is designated to be carry only necessary * information to look-up YANG model source and to be used by various * SchemaSourceProviders. * + *

      * Note:On source retrieval layer it is impossible to distinguish between * YANG module and/or submodule unless source is present. * @@ -38,7 +41,6 @@ public final class RevisionSourceIdentifier extends SourceIdentifier { private static final long serialVersionUID = 1L; /** - * * Creates new YANG Schema revision source identifier for sources without * a revision. * @@ -62,7 +64,6 @@ public final class RevisionSourceIdentifier extends SourceIdentifier { } /** - * * Creates new YANG Schema revision source identifier. * * @param name @@ -76,7 +77,6 @@ public final class RevisionSourceIdentifier extends SourceIdentifier { } /** - * * Creates new YANG Schema revision source identifier. * * @param moduleName diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SchemaRepository.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SchemaRepository.java index c86c25eb81..673929951f 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SchemaRepository.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SchemaRepository.java @@ -29,5 +29,6 @@ public interface SchemaRepository { */ SchemaContextFactory createSchemaContextFactory(@Nonnull SchemaSourceFilter filter); - CheckedFuture getSchemaSource(@Nonnull SourceIdentifier id, @Nonnull Class represetation); + CheckedFuture getSchemaSource( + @Nonnull SourceIdentifier id, @Nonnull Class represetation); } diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SchemaResolutionException.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SchemaResolutionException.java index bb9618de9e..608a8f7fbb 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SchemaResolutionException.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SchemaResolutionException.java @@ -64,7 +64,7 @@ public class SchemaResolutionException extends SchemaSourceException { } /** - * Return YANG schema source identifier consisting of name and revision of the module which caused this exception + * Return YANG schema source identifier consisting of name and revision of the module which caused this exception. * * @return YANG schema source identifier */ @@ -90,7 +90,8 @@ public class SchemaResolutionException extends SchemaSourceException { @Override public final String toString() { - return addToStringAttributes(MoreObjects.toStringHelper(this).add("unsatisfiedImports", unsatisfiedImports)).toString(); + return addToStringAttributes(MoreObjects.toStringHelper(this).add("unsatisfiedImports", unsatisfiedImports)) + .toString(); } protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) { diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SchemaSourceRepresentation.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SchemaSourceRepresentation.java index f4dc49b91b..4df8e7eb9a 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SchemaSourceRepresentation.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SchemaSourceRepresentation.java @@ -16,10 +16,12 @@ import org.opendaylight.yangtools.concepts.Immutable; /** * Common interface for schema source representations. * + *

      * A schema source is an atomic piece of the overall schema context. In YANG terms, * a schema source is semantically equivalent to a single YANG text file, be it a * module or a submodule. * + *

      * A schema source can exist in various forms, which we call representations. Again, * in YANG terms, each representation is semantically equivalent, but from * implementation perspective certain operations on a schema source may require it @@ -27,6 +29,7 @@ import org.opendaylight.yangtools.concepts.Immutable; * applied. Such transformations are affected via instances of * SchemaSourceTransformation. * + *

      * Typical examples of a schema source representation include: *

        *
      • a {@link java.lang.String} - textual representation of source code @@ -36,14 +39,11 @@ import org.opendaylight.yangtools.concepts.Immutable; *
      • Parsed abstract syntax tree (AST), which is the result of a syntactic parser *
      * - * Implementations of this interface expected to comply with the {@link Immutable} - * contract. + *

      + * Implementations of this interface expected to comply with the {@link Immutable} contract. */ @Beta public interface SchemaSourceRepresentation extends Identifiable, Immutable { - /** - * {@inheritDoc} - */ @Override SourceIdentifier getIdentifier(); diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SemVerSourceIdentifier.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SemVerSourceIdentifier.java index 76c9ec507d..f43ced86c6 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SemVerSourceIdentifier.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SemVerSourceIdentifier.java @@ -14,8 +14,9 @@ import org.opendaylight.yangtools.concepts.SemVer; import org.opendaylight.yangtools.yang.model.api.Module; /** - * YANG Schema source identifier with specified semantic version + * YANG Schema source identifier with specified semantic version. * + *

      * Simple transfer object represents identifier of source for YANG schema * (module or submodule), which consists of *

        @@ -24,9 +25,11 @@ import org.opendaylight.yangtools.yang.model.api.Module; *
      • (Optional) Module revision ({link {@link #getRevision()} *
      * + *

      * Source identifier is designated to be carry only necessary information to * look-up YANG model source and to be used by various SchemaSourceProviders. * + *

      * Note:On source retrieval layer it is impossible to distinguish between * YANG module and/or submodule unless source is present. * diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SourceIdentifier.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SourceIdentifier.java index 8692bedfe0..40c0751167 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SourceIdentifier.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SourceIdentifier.java @@ -23,9 +23,11 @@ import org.opendaylight.yangtools.yang.common.YangConstants; /** * Base class of YANG Schema source identifiers. * + *

      * Source identifiers are designated to be carry only necessary information to * look-up YANG model source and to be used by various SchemaSourceProviders. * + *

      * (For further reference see: http://tools.ietf.org/html/rfc6020#section-5.2 * and http://tools.ietf.org/html/rfc6022#section-3.1 ). */ @@ -43,9 +45,9 @@ public abstract class SourceIdentifier implements Identifier, Immutable { /** * Simplified compiled revision pattern in format YYYY-mm-dd, which checks * only distribution of number elements. + * *

      - * For checking if supplied string is real date, use - * {@link SimpleDateFormatUtil} instead. + * For checking if supplied string is real date, use {@link SimpleDateFormatUtil} instead. */ public static final Pattern REVISION_PATTERN = Pattern.compile(REVISION_PATTERN_STR); @@ -56,7 +58,6 @@ public abstract class SourceIdentifier implements Identifier, Immutable { private final String name; /** - * * Creates new YANG Schema source identifier for sources without revision. * * @param name @@ -104,7 +105,7 @@ public abstract class SourceIdentifier implements Identifier, Immutable { } /** - * Returns model name + * Returns model name. * * @return model name */ @@ -123,7 +124,6 @@ public abstract class SourceIdentifier implements Identifier, Immutable { } /** - *

      * Since we've got two ways of model versioning (revision & semantic version), * this method shouldn't be called directly anymore. Eventually, callers of this method * should be notified before method gets deleted. @@ -132,8 +132,7 @@ public abstract class SourceIdentifier implements Identifier, Immutable { *

    • {@link SemVerSourceIdentifier#create(String, SemVer)}
      • *
    • {@link SemVerSourceIdentifier#create(String, Optional, SemVer)}
      • *
    • {@link SemVerSourceIdentifier#create(String, String, SemVer)}
      • - *
    - * or + *
or *
    *
  • {@link RevisionSourceIdentifier#create(String)}
    • *
  • {@link RevisionSourceIdentifier#create(String, String)}
    • @@ -142,13 +141,10 @@ public abstract class SourceIdentifier implements Identifier, Immutable { * * @param moduleName * Name of schema - * @param revision * Revision of source in format YYYY-mm-dd. If not present, * default value will be used. - * * @return particular SourceIdentifier instance - * */ @Deprecated public static SourceIdentifier create(final String moduleName, final Optional revision) { @@ -158,11 +154,11 @@ public abstract class SourceIdentifier implements Identifier, Immutable { /** * Returns filename for this YANG module as specified in RFC 6020. * - * Returns filename in format name ['@' revision] '.yang' - *

    - * Where revision is date in format YYYY-mm-dd. *

    + * Returns filename in format name ['@' revision] '.yang', + * where revision is date in format YYYY-mm-dd. * + *

    * @see RFC6020 * * @return Filename for this source identifier. @@ -175,9 +171,9 @@ public abstract class SourceIdentifier implements Identifier, Immutable { /** * Returns filename for this YANG module as specified in RFC 6020. * - * Returns filename in format moduleName ['@' revision] '.yang' - * - * Where Where revision-date is in format YYYY-mm-dd. + *

    + * Returns filename in format moduleName ['@' revision] '.yang', + * where Where revision-date is in format YYYY-mm-dd. * *

    * See http://tools.ietf.org/html/rfc6020#section-5.2 diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/YinDomSchemaSource.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/YinDomSchemaSource.java index cc91d44a6e..096932bd06 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/YinDomSchemaSource.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/YinDomSchemaSource.java @@ -63,8 +63,8 @@ public abstract class YinDomSchemaSource implements YinXmlSchemaSource { final QName qname = QName.create(rootNs, root.getLocalName()); Preconditions.checkArgument(RFC6020_YIN_MODULE.equals(qname.getModule()), "Root node namepsace %s does not match %s", rootNs, YangConstants.RFC6020_YIN_NAMESPACE); - Preconditions.checkArgument(MODULE.getStatementName().equals(qname) || - SUBMODULE.getStatementName().equals(qname), "Root element %s is not a module nor a submodule", qname); + Preconditions.checkArgument(MODULE.getStatementName().equals(qname) + || SUBMODULE.getStatementName().equals(qname), "Root element %s is not a module nor a submodule", qname); Preconditions.checkArgument(root instanceof Element, "Root node %s is not an element", root); final Element element = (Element)root; @@ -117,7 +117,8 @@ public abstract class YinDomSchemaSource implements YinXmlSchemaSource { * @return A {@link YinDomSchemaSource} instance * @throws TransformerException when the provided source fails to transform */ - @Nonnull public static YinDomSchemaSource transform(final YinXmlSchemaSource xmlSchemaSource) throws TransformerException { + @Nonnull public static YinDomSchemaSource transform(final YinXmlSchemaSource xmlSchemaSource) + throws TransformerException { final YinDomSchemaSource cast = castSchemaSource(xmlSchemaSource); return cast != null ? cast : create(xmlSchemaSource.getIdentifier(), transformSource(xmlSchemaSource.getSource())); diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/YinTextSchemaSource.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/YinTextSchemaSource.java index fa2813eb08..a1a7060f91 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/YinTextSchemaSource.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/YinTextSchemaSource.java @@ -53,17 +53,11 @@ public abstract class YinTextSchemaSource extends ByteSource implements YinSchem return RevisionSourceIdentifier.create(parsed.getKey(), Optional.fromNullable(parsed.getValue())); } - /** - * {@inheritDoc} - */ @Override public final SourceIdentifier getIdentifier() { return identifier; } - /** - * {@inheritDoc} - */ @Nonnull @Override public Class getType() { @@ -94,11 +88,13 @@ public abstract class YinTextSchemaSource extends ByteSource implements YinSchem * @param delegate Backing ByteSource instance * @return A new YinTextSchemaSource */ - public static YinTextSchemaSource delegateForByteSource(final SourceIdentifier identifier, final ByteSource delegate) { + public static YinTextSchemaSource delegateForByteSource(final SourceIdentifier identifier, + final ByteSource delegate) { return new DelegatedYinTextSchemaSource(identifier, delegate); } - private static final class DelegatedYinTextSchemaSource extends YinTextSchemaSource implements Delegator { + private static final class DelegatedYinTextSchemaSource extends YinTextSchemaSource + implements Delegator { private final ByteSource delegate; private DelegatedYinTextSchemaSource(final SourceIdentifier identifier, final ByteSource delegate) { diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/spi/PotentialSchemaSource.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/spi/PotentialSchemaSource.java index 8b9732dd8e..80d23a94ff 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/spi/PotentialSchemaSource.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/spi/PotentialSchemaSource.java @@ -69,14 +69,16 @@ public final class PotentialSchemaSource { private final SourceIdentifier sourceIdentifier; private final int cost; - private PotentialSchemaSource(final SourceIdentifier sourceIdentifier, final Class representation, final int cost) { + private PotentialSchemaSource(final SourceIdentifier sourceIdentifier, final Class representation, + final int cost) { this.representation = Preconditions.checkNotNull(representation); this.sourceIdentifier = Preconditions.checkNotNull(sourceIdentifier); Preconditions.checkArgument(cost >= 0, "cost has to be non-negative"); this.cost = cost; } - public static PotentialSchemaSource create(final SourceIdentifier sourceIdentifier, final Class representation, final int cost) { + public static PotentialSchemaSource create( + final SourceIdentifier sourceIdentifier, final Class representation, final int cost) { return new PotentialSchemaSource<>(sourceIdentifier, representation, cost); } diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/spi/SchemaSourceProvider.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/spi/SchemaSourceProvider.java index cdf6701805..00f8040ff7 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/spi/SchemaSourceProvider.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/spi/SchemaSourceProvider.java @@ -34,10 +34,12 @@ public interface SchemaSourceProvider { * the newest available revision, or throws {@link MissingSchemaSourceException}. *

* + *

* In either case the returned representation is required to report a non-null * revision in the {@link SourceIdentifier} returned from * {@link SchemaSourceRepresentation#getIdentifier()}. * + *

* Implementations are not required to provide constant behavior in time, notably * this different invocation of this method may produce different results. * diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/spi/SchemaSourceRegistration.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/spi/SchemaSourceRegistration.java index d59c78d0f7..781bfd56bd 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/spi/SchemaSourceRegistration.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/spi/SchemaSourceRegistration.java @@ -15,7 +15,8 @@ import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceRepresentation * Registration of a schema source. */ @Beta -public interface SchemaSourceRegistration extends ObjectRegistration> { +public interface SchemaSourceRegistration + extends ObjectRegistration> { @Override void close(); } diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/spi/SchemaSourceRegistry.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/spi/SchemaSourceRegistry.java index 1b35c51d1c..dfa34b79a4 100644 --- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/spi/SchemaSourceRegistry.java +++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/spi/SchemaSourceRegistry.java @@ -30,7 +30,8 @@ public interface SchemaSourceRegistry { * @return A registration handle. Invoking {@link SchemaSourceRegistration#close()} * will cancel the registration. */ - SchemaSourceRegistration registerSchemaSource(SchemaSourceProvider provider, PotentialSchemaSource source); + SchemaSourceRegistration registerSchemaSource( + SchemaSourceProvider provider, PotentialSchemaSource source); /** * Register a schema source listener. The listener will be notified as new -- 2.36.6