From f81f2bd40c093fabd8f96fe8bd42dec4ad7fc3bf Mon Sep 17 00:00:00 2001 From: Jie Han Date: Thu, 19 Oct 2017 13:45:02 +0800 Subject: [PATCH] Fix checkstyle in mdsal-binding2-dom-codec - Fix checkstyle issues and activate enforcement. Change-Id: I9857df844aba6bee4ddc729fb8246a2d8a085ad5 Signed-off-by: Jie Han --- binding2/mdsal-binding2-dom-codec/pom.xml | 7 ++ .../dom/codec/api/AugmentationReader.java | 1 + .../BindingNormalizedNodeCachingCodec.java | 2 + .../dom/codec/api/BindingTreeCodec.java | 1 + .../dom/codec/api/BindingTreeNodeCodec.java | 1 + .../BindingNormalizedNodeWriterFactory.java | 4 +- .../generator/impl/StaticBindingProperty.java | 3 +- .../generator/impl/StreamWriterGenerator.java | 1 + .../impl/TreeNodeSerializerPrototype.java | 4 +- .../spi/generator/AbstractGenerator.java | 2 +- .../AbstractStreamWriterGenerator.java | 52 +++++---- ...entableDataNodeContainerEmitterSource.java | 4 +- ...ractDataNodeContainerSerializerSource.java | 103 ++++++++++-------- .../generator/spi/source/AbstractSource.java | 26 ++--- .../BindingNormalizedNodeCodecRegistry.java | 3 +- .../impl/BindingToNormalizedNodeCodec.java | 4 +- .../dom/codec/impl/IdentifiableItemCodec.java | 4 +- .../codec/impl/MissingSchemaException.java | 4 +- .../dom/codec/impl/OperationInputCodec.java | 1 + .../cache/BindingNormalizedNodeCache.java | 1 + .../impl/context/ChoiceNodeCodecContext.java | 10 +- .../impl/context/SchemaRootCodecContext.java | 63 ++++++----- .../impl/context/UnionValueOptionContext.java | 2 + .../dom/codec/impl/context/ValueContext.java | 4 +- .../context/base/BindingCodecContext.java | 5 +- .../base/DataContainerCodecContext.java | 13 ++- .../base/DataContainerCodecPrototype.java | 20 ++-- .../codec/impl/context/base/LazyTreeNode.java | 8 +- .../context/base/LeafNodeCodecContext.java | 5 +- .../base/MissingSchemaForClassException.java | 1 + .../impl/context/base/NodeCodecContext.java | 11 +- .../context/base/TreeNodeCodecContext.java | 18 +-- .../CachingNormalizedNodeSerializer.java | 27 +++-- .../dom/codec/impl/value/BitsCodec.java | 3 +- .../impl/value/EncapsulatedValueCodec.java | 2 + .../dom/codec/impl/value/ValueTypeCodec.java | 15 +-- 36 files changed, 245 insertions(+), 190 deletions(-) diff --git a/binding2/mdsal-binding2-dom-codec/pom.xml b/binding2/mdsal-binding2-dom-codec/pom.xml index ca019c88b3..912fd54e62 100644 --- a/binding2/mdsal-binding2-dom-codec/pom.xml +++ b/binding2/mdsal-binding2-dom-codec/pom.xml @@ -114,6 +114,13 @@ + + org.apache.maven.plugins + maven-checkstyle-plugin + + checkstyle.violationSeverity=error + + diff --git a/binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/api/AugmentationReader.java b/binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/api/AugmentationReader.java index a5243a3777..4fc0bd3562 100644 --- a/binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/api/AugmentationReader.java +++ b/binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/api/AugmentationReader.java @@ -18,6 +18,7 @@ import org.opendaylight.mdsal.binding.javav2.spec.structural.Augmentation; * obtain augmentations from proxy implementations of {@link Augmentable} * object. * + *

* If implemented proxy does not implement this interface, its augmentations are * not properly serialized / deserialized. */ diff --git a/binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/api/BindingNormalizedNodeCachingCodec.java b/binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/api/BindingNormalizedNodeCachingCodec.java index f3071d73c5..60aa0dc1cc 100644 --- a/binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/api/BindingNormalizedNodeCachingCodec.java +++ b/binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/api/BindingNormalizedNodeCachingCodec.java @@ -13,6 +13,7 @@ import org.opendaylight.mdsal.binding.javav2.spec.base.TreeNode; /** * Caching variant of Binding to Normalized Node codec. * + *

* Caching may introduce performance penalty to serialization / deserialization * but may decrease use of heap for repetitive objects. * @@ -27,6 +28,7 @@ public interface BindingNormalizedNodeCachingCodec * Invoking close will invalidate this codec and any of its child codecs and * will invalidate cache. * + *

* Any subsequent calls to this codec will fail with * {@link IllegalStateException} thrown. */ diff --git a/binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/api/BindingTreeCodec.java b/binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/api/BindingTreeCodec.java index 71f800ce71..226fec66a6 100644 --- a/binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/api/BindingTreeCodec.java +++ b/binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/api/BindingTreeCodec.java @@ -17,6 +17,7 @@ import org.opendaylight.yangtools.yang.model.api.SchemaPath; /** * Navigable tree representing hierarchy of Binding to Normalized Node codecs. * + *

* This navigable tree is associated to concrete set of YANG models, represented * by SchemaContext and provides access to subtree specific serialization * context. diff --git a/binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/api/BindingTreeNodeCodec.java b/binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/api/BindingTreeNodeCodec.java index e971bf2837..e02c935314 100644 --- a/binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/api/BindingTreeNodeCodec.java +++ b/binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/api/BindingTreeNodeCodec.java @@ -104,6 +104,7 @@ public interface BindingTreeNodeCodec extends BindingNormali /** * Returns codec which uses caches serialization / deserialization results. * + *

* Caching may introduce performance penalty to serialization / * deserialization but may decrease use of heap for repetitive objects. * diff --git a/binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/api/factory/BindingNormalizedNodeWriterFactory.java b/binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/api/factory/BindingNormalizedNodeWriterFactory.java index 187e3a7f11..440750c279 100644 --- a/binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/api/factory/BindingNormalizedNodeWriterFactory.java +++ b/binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/api/factory/BindingNormalizedNodeWriterFactory.java @@ -29,10 +29,12 @@ public interface BindingNormalizedNodeWriterFactory { * Creates a {@link BindingStreamEventWriter} for data tree path which will * translate to NormalizedNode model and invoke proper events on supplied * {@link NormalizedNodeStreamWriter}. + * *

* Also provides translation of supplied Instance Identifier to * {@link YangInstanceIdentifier} so client code, does not need to translate * that separately. + * *

* If {@link YangInstanceIdentifier} is not needed, please use * {@link #newWriter(InstanceIdentifier, NormalizedNodeStreamWriter)} method @@ -56,8 +58,8 @@ public interface BindingNormalizedNodeWriterFactory { * Creates a {@link BindingStreamEventWriter} for data tree path which will * translate to NormalizedNode model and invoke proper events on supplied * {@link NormalizedNodeStreamWriter}. - *

* + *

* This variation does not provide YANG instance identifier and is useful * for use-cases, where {@link InstanceIdentifier} translation is done in * other way, or YANG instance identifier is unnecessary (e.g. diff --git a/binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/generator/impl/StaticBindingProperty.java b/binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/generator/impl/StaticBindingProperty.java index ff0c0a9e5c..94fef6b73b 100644 --- a/binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/generator/impl/StaticBindingProperty.java +++ b/binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/generator/impl/StaticBindingProperty.java @@ -11,7 +11,8 @@ import com.google.common.annotations.Beta; import com.google.common.base.Preconditions; /** - * Definition of static property for Binding objects + * Definition of static property for Binding objects. + * *

* This definition consists of *