org.opendaylight.mdsal.binding.api.WriteOperations Maven / Gradle / Ivy
/*
* 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
*/
void put(@NonNull LogicalDatastoreType store, @NonNull InstanceIdentifier path,
@NonNull 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.
*
*
* 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
void put(@NonNull LogicalDatastoreType store, @NonNull InstanceIdentifier path,
@NonNull T data, boolean createMissingParents);
/**
* 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. Unlike
* {@link #put(LogicalDatastoreType, InstanceIdentifier, DataObject)}, this method will attempt to create
* semantically-significant parent nodes, like list entries and presence containers, as indicated by {@code path}.
*
*
* 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
*/
// FIXME: 4.0.0: make this method non-default
// TODO: can we come up with a better name?
@Beta
default void mergeParentStructurePut(@NonNull final LogicalDatastoreType store,
@NonNull final InstanceIdentifier path, @NonNull final T data) {
put(store, path, data, CREATE_MISSING_PARENTS);
}
/**
* 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.
*
*
* 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
*/
void merge(@NonNull LogicalDatastoreType store, @NonNull InstanceIdentifier path,
@NonNull 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.
*
*
* 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
void merge(@NonNull LogicalDatastoreType store, @NonNull InstanceIdentifier path,
@NonNull 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. Unlike
* {@link #merge(LogicalDatastoreType, InstanceIdentifier, DataObject)}, this method will attempt to create
* semantically-significant parent nodes, like list entries and presence containers, as indicated by {@code path}.
*
*
* 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
*/
// FIXME: 4.0.0: make this method non-default
// TODO: can we come up with a better name?
@Beta
default void mergeParentStructureMerge(@NonNull final LogicalDatastoreType store,
@NonNull final InstanceIdentifier path, @NonNull final T data) {
merge(store, path, data, CREATE_MISSING_PARENTS);
}
/**
* Removes a piece of data from specified path. This operation does not fail if the specified path does not exist.
*
* @param store Logical data store which should be modified
* @param path Data object path
* @throws IllegalStateException if the transaction was committed or canceled.
*/
void delete(@NonNull LogicalDatastoreType store, @NonNull InstanceIdentifier path);
/**
* Flag value indicating that missing parents should be created.
*
*
* 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;
}