Fixup checkstyle
[controller.git] / opendaylight / md-sal / sal-binding-api / src / main / java / org / opendaylight / controller / md / sal / binding / api / WriteTransaction.java
index 1bd5404..3c4591a 100644 (file)
@@ -22,109 +22,92 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  */
 @Deprecated
 public interface WriteTransaction extends AsyncWriteTransaction<InstanceIdentifier<?>, DataObject> {
-
     /**
-     * Stores a piece of data at the specified path. This acts as an add / replace
-     * operation, which is to say that whole subtree will be replaced by the specified data.
-     * * <p>
+     * Stores a piece of data at the specified path. This acts as an add / replace operation, which is to say that whole
+     * subtree will be replaced by the specified data.
+     *
+     * <p>
      * This method does not automatically create missing parent nodes. It is equivalent to invoking
-     * {@link #put(LogicalDatastoreType, InstanceIdentifier, DataObject, boolean)}
-     * with <code>createMissingParents</code> set to false.
+     * {@link #put(LogicalDatastoreType, InstanceIdentifier, DataObject, boolean)} with {@code createMissingParents} set
+     * to false.
+     *
      * <p>
      * For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}.
+     *
      * <p>
-     * If you need to make sure that a parent object exists but you do not want modify
-     * its pre-existing state by using put, consider using {@link #merge} instead.
+     * If you need to make sure that a parent object exists but you do not want modify its pre-existing state by using
+     * put, consider using {@link #merge} instead.
      *
-     * @param store
-     *            the logical data store which should be modified
-     * @param path
-     *            the data object path
-     * @param data
-     *            the data object to be written to the specified path
-     * @throws IllegalStateException
-     *             if the transaction has already been submitted
+     * @param store the logical data store which should be modified
+     * @param path the data object path
+     * @param data the data object to be written to the specified path
+     * @throws IllegalStateException if the transaction has already been submitted
      */
     <T extends DataObject> void put(LogicalDatastoreType store, InstanceIdentifier<T> path, T data);
 
-
     /**
-     * Stores a piece of data at the specified path. This acts as an add /
-     * replace operation, which is to say that whole subtree will be replaced by
-     * the specified data.
+     * Stores a piece of data at the specified path. This acts as an add / replace operation, which is to say that whole
+     * subtree will be replaced by the specified data.
+     *
      * <p>
-     * For more information on usage and examples, please see the documentation
-     * in {@link AsyncWriteTransaction}.
+     * For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}.
+     *
      * <p>
-     * If you need to make sure that a parent object exists but you do not want
-     * modify its pre-existing state by using put, consider using {@link #merge}
-     * instead.
+     * If you need to make sure that a parent object exists but you do not want modify its pre-existing state by using
+     * put, consider using {@link #merge} instead.
      *
-     * Note: Using <code>createMissingParents</code> with value true, may
-     * introduce garbage in data store, or recreate nodes, which were deleted by
-     * previous transaction.
+     * <p>
+     * Note: Using <code>createMissingParents</code> with value true, may introduce garbage in data store, or recreate
+     * nodes, which were deleted by previous transaction.
      *
-     * @param store
-     *            the logical data store which should be modified
-     * @param path
-     *            the data object path
-     * @param data
-     *            the data object to be written to the specified path
-     * @param createMissingParents
-     *            if {@link #CREATE_MISSING_PARENTS} ({@code true}), any missing
-     *            parent nodes will be automatically created using a merge
-     *            operation.
-     * @throws IllegalStateException
-     *             if the transaction has already been submitted
+     * @param store the logical data store which should be modified
+     * @param path the data object path
+     * @param data the data object to be written to the specified path
+     * @param createMissingParents if {@link #CREATE_MISSING_PARENTS} ({@code true}), any missing parent nodes will be
+     *                             automatically created using a merge operation.
+     * @throws IllegalStateException if the transaction has already been submitted
      */
     <T extends DataObject> void put(LogicalDatastoreType store, InstanceIdentifier<T> path, T data,
             boolean createMissingParents);
 
     /**
-     * Merges a piece of data with the existing data at a specified path. Any pre-existing data
-     * which is not explicitly overwritten will be preserved. This means that if you store a container,
-     * its child lists will be merged.
+     * Merges a piece of data with the existing data at a specified path. Any pre-existing data which is not explicitly
+     * overwritten will be preserved. This means that if you store a container, its child lists will be merged.
+     *
      * <p>
      * This method does not automatically create missing parent nodes. It is equivalent to invoking
-     * {@link #merge(LogicalDatastoreType, InstanceIdentifier, DataObject, boolean)}
-     * with <code>createMissingParents</code> set to false.
+     * {@link #merge(LogicalDatastoreType, InstanceIdentifier, DataObject, boolean)} with {@code createMissingParents}
+     * set to false.
+     *
      * <p>
      * For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}.
-     *<p>
+     *
+     * <p>
      * If you require an explicit replace operation, use {@link #put} instead.
-     * @param store
-     *            the logical data store which should be modified
-     * @param path
-     *            the data object path
-     * @param data
-     *            the data object to be merged to the specified path
-     * @throws IllegalStateException
-     *             if the transaction has already been submitted
+     *
+     * @param store the logical data store which should be modified
+     * @param path the data object path
+     * @param data the data object to be merged to the specified path
+     * @throws IllegalStateException if the transaction has already been submitted
      */
     <T extends DataObject> void merge(LogicalDatastoreType store, InstanceIdentifier<T> path, T data);
 
     /**
-     * Merges a piece of data with the existing data at a specified path. Any
-     * pre-existing data which is not explicitly overwritten will be preserved.
-     * This means that if you store a container, its child lists will be merged.
+     * Merges a piece of data with the existing data at a specified path. Any pre-existing data which is not explicitly
+     * overwritten will be preserved. This means that if you store a container, its child lists will be merged.
+     *
      * <p>
-     * For more information on usage and examples, please see the documentation
-     * in {@link AsyncWriteTransaction}.
+     * For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}.
+     *
      * <p>
      * If you require an explicit replace operation, use {@link #put} instead.
      *
-     * @param store
-     *            the logical data store which should be modified
-     * @param path
-     *            the data object path
-     * @param data
-     *            the data object to be merged to the specified path
-     * @param createMissingParents
-     *            if {@link #CREATE_MISSING_PARENTS} ({@code true}), any missing
-     *            parent nodes will be automatically created using a merge
-     *            operation.
-     * @throws IllegalStateException
-     *             if the transaction has already been submitted
+     * @param store the logical data store which should be modified
+     * @param path the data object path
+     * @param data the data object to be merged to the specified path
+     * @param createMissingParents if {@link #CREATE_MISSING_PARENTS} ({@code true}), any missing parent nodes will be
+     *                             automatically created using a merge operation.
+     * @throws IllegalStateException if the transaction has already been submitted
      */
     <T extends DataObject> void merge(LogicalDatastoreType store, InstanceIdentifier<T> path, T data,
             boolean createMissingParents);

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.