/* * Copyright (c) 2018 Pantheon Technologies, s.r.o. and others. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ package org.opendaylight.mdsal.binding.api; import com.google.common.annotations.Beta; import org.eclipse.jdt.annotation.NonNull; import org.opendaylight.mdsal.common.api.LogicalDatastoreType; import org.opendaylight.yangtools.yang.binding.DataObject; import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; /** * Write-like operations supported by {@link WriteTransaction} and {@link ReadWriteTransaction}. This interface defines * the operations without a tie-in with lifecycle management. */ public interface WriteOperations { /** * 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. * *
* 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
* @throws NullPointerException if any of the arguments is null
*/
* 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.
*
* WARNING: Using this method may introduce garbage in data store, or recreate nodes, which were deleted by
* a previous transaction. It is not necessary in most scenarios and has a significantly higher cost
* than {@link #put(LogicalDatastoreType, InstanceIdentifier, DataObject)} and should only be used
* when absolutely necessary.
*
* @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}, any missing parent nodes will be automatically
* created using a merge operation. WARNING: using this option is not needed
* in most scenarios and has a significant performance cost and should be avoided
* whenever possible.
* @throws IllegalStateException if the transaction has already been submitted
* @throws NullPointerException if any of the arguments is null
* @deprecated Use {@link #put(LogicalDatastoreType, InstanceIdentifier, DataObject)} or
* {@link #mergeParentStructurePut(LogicalDatastoreType, InstanceIdentifier, DataObject)}
* instead.
*/
@Deprecated
default
* 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.
*
*
* WARNING: Using this method may introduce garbage in data store, or recreate nodes, which were deleted by
* a previous transaction. It also has a significantly higher cost than
* {@link #put(LogicalDatastoreType, InstanceIdentifier, DataObject)} and should only be used when
* absolutely necessary.
*
* @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
* @throws NullPointerException if any of the arguments is null
*/
// TODO: can we come up with a better name?
@Beta
* 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
* @throws NullPointerException if any of the arguments is null
*/
* 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}, any missing parent nodes will be automatically
* created using a merge operation. WARNING: using this option is not needed
* in most scenarios and has a significant performance cost and should be avoided
* whenever possible.
* @throws IllegalStateException if the transaction has already been submitted
* @throws NullPointerException if any of the arguments is null
* @deprecated Use {@link #merge(LogicalDatastoreType, InstanceIdentifier, DataObject)} or
* {@link #mergeParentStructureMerge(LogicalDatastoreType, InstanceIdentifier, DataObject)}
* instead.
*/
@Deprecated
default
* If you require an explicit replace operation, use {@link #put} instead.
*
*
* WARNING: Using this method may introduce garbage in data store, or recreate nodes, which were deleted by
* a previous transaction. It is not necessary in most scenarios and has a significantly higher cost
* than {@link #merge(LogicalDatastoreType, InstanceIdentifier, DataObject)}. It should only be used
* when absolutely necessary.
*
* @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
* @throws NullPointerException if any of the arguments is null
*/
// TODO: can we come up with a better name?
@Beta
* WARNING: Using this flag may introduce garbage in data store, or recreate nodes, which were deleted by
* a previous transaction. It is not necessary in most scenarios and also has a significantly higher
* cost than {@link #FAIL_ON_MISSING_PARENTS} and should only be used when absolutely necessary.
*
* @deprecated To be removed with {@link #merge(LogicalDatastoreType, InstanceIdentifier, DataObject, boolean)}
* and {@link #put(LogicalDatastoreType, InstanceIdentifier, DataObject, boolean)}.
*/
@Deprecated
boolean CREATE_MISSING_PARENTS = true;
/**
* Flag value indicating that missing parents should cause an error.
*
* @deprecated To be removed with {@link #merge(LogicalDatastoreType, InstanceIdentifier, DataObject, boolean)}
* and {@link #put(LogicalDatastoreType, InstanceIdentifier, DataObject, boolean)}.
*/
@Deprecated
boolean FAIL_ON_MISSING_PARENTS = false;
}