Fix checkstyle in mdsal-binding-dom-codec
[mdsal.git] / binding / mdsal-binding-dom-codec / src / main / java / org / opendaylight / mdsal / binding / dom / codec / api / BindingCodecTreeNode.java
index 6943433667a04a005c7de6e52e7ab530a628d400..25a4d43e6de32a77adf58d7dfc94c2e4ab08ebfd 100644 (file)
@@ -20,18 +20,14 @@ import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
 
 /**
- * Subtree codec specific to model subtree between Java Binding and
- * NormalizedNode.
+ * Subtree codec specific to model subtree between Java Binding and NormalizedNode.
  */
 @Beta
 public interface BindingCodecTreeNode<T extends DataObject> extends BindingNormalizedNodeCodec<T> {
 
     /**
-     * Returns binding class of interface which represents API of current
-     * schema node.
-     *
-     * The result is same as invoking {@link DataObject#getImplementedInterface()}
-     * on instance of data.
+     * Returns binding class of interface which represents API of current schema node. The result is same as invoking
+     * {@link DataObject#getImplementedInterface()} on instance of data.
      *
      * @return interface which defines API of binding representation of data.
      */
@@ -39,9 +35,8 @@ public interface BindingCodecTreeNode<T extends DataObject> extends BindingNorma
     Class<T> getBindingClass();
 
     /**
-     * Returns child context as if it was walked by
-     * {@link BindingStreamEventWriter}. This means that to enter case, one must
-     * issue getChild(ChoiceClass).getChild(CaseClass).
+     * Returns child context as if it was walked by {@link BindingStreamEventWriter}. This means that to enter case,
+     * one must issue getChild(ChoiceClass).getChild(CaseClass).
      *
      * @param childClass Child class by Biding Stream navigation
      * @return Context of child
@@ -52,24 +47,23 @@ public interface BindingCodecTreeNode<T extends DataObject> extends BindingNorma
     <E extends DataObject> BindingCodecTreeNode<E> streamChild(@Nonnull Class<E> childClass);
 
     /**
-     * Returns child context as if it was walked by
-     * {@link BindingStreamEventWriter}. This means that to enter case, one must
-     * issue getChild(ChoiceClass).getChild(CaseClass).
+     * Returns child context as if it was walked by {@link BindingStreamEventWriter}. This means that to enter case,
+     * one must issue getChild(ChoiceClass).getChild(CaseClass).
      *
-     * This method differs from {@link #streamChild(Class)}, that is less
-     * stricter for interfaces representing augmentation and cases, that
-     * may return {@link BindingCodecTreeNode} even if augmentation interface
-     * containing same data was supplied and does not represent augmentation
-     * of this node.
+     * <p>
+     * This method differs from {@link #streamChild(Class)}, that is less strict for interfaces representing
+     * augmentation and cases, that may return {@link BindingCodecTreeNode} even if augmentation interface containing
+     * same data was supplied and does not represent augmentation of this node.
      *
      * @param childClass
      * @return Context of child or Optional absent is supplied class is not
      *         applicable in context.
      */
-    <E extends DataObject> Optional<? extends BindingCodecTreeNode<E>> possibleStreamChild(@Nonnull Class<E> childClass);
+    <E extends DataObject> Optional<? extends BindingCodecTreeNode<E>> possibleStreamChild(
+            @Nonnull Class<E> childClass);
 
     /**
-     * Returns nested node context using supplied YANG Instance Identifier
+     * Returns nested node context using supplied YANG Instance Identifier.
      *
      * @param child
      *            Yang Instance Identifier Argument
@@ -81,8 +75,8 @@ public interface BindingCodecTreeNode<T extends DataObject> extends BindingNorma
     BindingCodecTreeNode<?> yangPathArgumentChild(@Nonnull YangInstanceIdentifier.PathArgument child);
 
     /**
-     * Returns nested node context using supplied Binding Instance Identifier
-     * and adds YANG instance identifiers to supplied list.
+     * Returns nested node context using supplied Binding Instance Identifier and adds YANG instance identifiers to
+     * the supplied list.
      *
      * @param arg
      *            Binding Instance Identifier Argument
@@ -98,12 +92,12 @@ public interface BindingCodecTreeNode<T extends DataObject> extends BindingNorma
             @Nullable List<YangInstanceIdentifier.PathArgument> builder);
 
     /**
-     * Returns codec which uses caches serialization / deserialization results
+     * Returns codec which uses caches serialization / deserialization results.
      *
+     * <p>
      * Caching may introduce performance penalty to serialization / deserialization
      * but may decrease use of heap for repetitive objects.
      *
-     *
      * @param cacheSpecifier Set of objects, for which cache may be in place
      * @return Codec whihc uses cache for serialization / deserialization.
      */
@@ -136,7 +130,8 @@ public interface BindingCodecTreeNode<T extends DataObject> extends BindingNorma
      * @throws IllegalArgumentException If supplied {@code arg} is not valid.
      */
     @Beta
-    @Nullable InstanceIdentifier.PathArgument deserializePathArgument(@Nullable YangInstanceIdentifier.PathArgument arg);
+    @Nullable InstanceIdentifier.PathArgument deserializePathArgument(
+            @Nullable YangInstanceIdentifier.PathArgument arg);
 
     Object getSchema();
 }