Package org.somda.sdc.biceps.common

Class MdibDescriptionModifications

java.lang.Object

org.somda.sdc.biceps.common.MdibDescriptionModifications

public class MdibDescriptionModifications
extends Object

Container to collect changes supposed to be applied on an MDIB.

The MdibDescriptionModifications is a fluent interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MdibDescriptionModifications.Entry	An entry that allows to bundle all single-state modification information in a single element.
static class	MdibDescriptionModifications.MultiStateEntry	An entry that allows to bundle all multi-state modification information in a single element.

Method Summary

Modifier and Type	Method	Description
MdibDescriptionModifications	add(MdibDescriptionModification.Type modType, MdibDescriptionModifications.Entry entry)	Adds a change.
MdibDescriptionModifications	add(MdibDescriptionModification.Type modType, MdibDescriptionModifications.MultiStateEntry entry)	Adds a change.
MdibDescriptionModifications	add(MdibDescriptionModification.Type modType, AbstractDescriptor descriptor)	Add single or multi state descriptor to change set without state information.
MdibDescriptionModifications	add(MdibDescriptionModification.Type modType, AbstractDescriptor descriptor, String parentHandle)	Adds single or multi state descriptor to change set without state information.
MdibDescriptionModifications	add(MdibDescriptionModification.Type modType, AbstractDescriptor descriptor, List<? extends AbstractMultiState> multiStates)	Add multi state descriptor to change set with state information.
MdibDescriptionModifications	add(MdibDescriptionModification.Type modType, AbstractDescriptor descriptor, List<? extends AbstractMultiState> multiStates, String parentHandle)	Add multi state descriptor to change set with state information.
MdibDescriptionModifications	add(MdibDescriptionModification.Type modType, AbstractDescriptor descriptor, AbstractState state)	Add single state descriptor to change set with state information.
MdibDescriptionModifications	add(MdibDescriptionModification.Type modType, AbstractDescriptor descriptor, AbstractState state, String parentHandle)	Add single state descriptor to change set with state information.
void	clear()	Empties all modifications.
static MdibDescriptionModifications	create()	Creates a set.
MdibDescriptionModifications	delete(String handle)	Convenient function to delete a descriptor.
MdibDescriptionModifications	delete(MdibDescriptionModifications.Entry entry)	Convenient function to update a descriptor.
MdibDescriptionModifications	delete(AbstractDescriptor descriptor)	Convenient function to delete a descriptor.
List<MdibDescriptionModification>	getModifications()	Function to get all changes as unmodifiable list.
MdibDescriptionModifications	insert(MdibDescriptionModifications.Entry entry)	Convenient function to insert a descriptor.
MdibDescriptionModifications	insert(MdibDescriptionModifications.MultiStateEntry entry)	Convenient function to insert a descriptor.
MdibDescriptionModifications	insert(AbstractDescriptor descriptor)	Convenient function to insert a descriptor.
MdibDescriptionModifications	insert(AbstractDescriptor descriptor, String parentHandle)	Convenient function to insert a descriptor.
MdibDescriptionModifications	insert(AbstractDescriptor descriptor, List<? extends AbstractMultiState> multiStates)	Convenient function to insert a multi state descriptor with state information.
MdibDescriptionModifications	insert(AbstractDescriptor descriptor, List<? extends AbstractMultiState> multiStates, String parentHandle)	Convenient function to insert a multi state descriptor with state information.
MdibDescriptionModifications	insert(AbstractDescriptor descriptor, AbstractState state)	Convenient function to insert a single state descriptor with state information.
MdibDescriptionModifications	insert(AbstractDescriptor descriptor, AbstractState state, String parentHandle)	Convenient function to insert a single state descriptor with state information.
boolean	isAddedAsDeleted(String handle)	Checks if a handle was added as deleted.
boolean	isAddedAsInserted(String handle)	Checks if a handle was added as inserted.
boolean	isAddedAsUpdated(String handle)	Checks if a handle was added as updated.
MdibDescriptionModifications	update(MdibDescriptionModifications.Entry entry)	Convenient function to update a descriptor.
MdibDescriptionModifications	update(MdibDescriptionModifications.MultiStateEntry entry)	Convenient function to update a descriptor.
MdibDescriptionModifications	update(AbstractDescriptor descriptor)	Convenient function to update a descriptor.
MdibDescriptionModifications	update(AbstractDescriptor descriptor, List<? extends AbstractMultiState> multiStates)	Convenient function to update a multi state descriptor with state information.
MdibDescriptionModifications	update(AbstractDescriptor descriptor, AbstractState state)	Convenient function to update a single state descriptor with state information.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static MdibDescriptionModifications create()

Creates a set.

Returns:

a new MdibDescriptionModifications instance.

add

public MdibDescriptionModifications add(MdibDescriptionModification.Type modType,
                                        MdibDescriptionModifications.Entry entry)

Adds a change.

Parameters:

modType - the modification type.

entry - an entry that contains all necessary modification information.

Returns:

this object for fluent access.

add

public MdibDescriptionModifications add(MdibDescriptionModification.Type modType,
                                        MdibDescriptionModifications.MultiStateEntry entry)

Adds a change.

Parameters:

modType - the modification type.

entry - a multi-state entry that contains all necessary modification information.

Returns:

this object for fluent access.

add

public MdibDescriptionModifications add(MdibDescriptionModification.Type modType,
                                        AbstractDescriptor descriptor,
                                        @Nullable
                                        String parentHandle)

Adds single or multi state descriptor to change set without state information.

It's up to the change set processor to align state information.

Parameters:

modType - the modification type.

descriptor - the descriptor to add.

parentHandle - the parent handle, allowed to be null in case of MDS or if it can be derived during preprocessing.

Returns:

this object for fluent access.

add

public MdibDescriptionModifications add(MdibDescriptionModification.Type modType,
                                        AbstractDescriptor descriptor)

Add single or multi state descriptor to change set without state information.

It's up to the change set processor to align state information.

Parameters:

modType - the modification type.

descriptor - the descriptor to add.

Returns:

this object for fluent access.

add

public MdibDescriptionModifications add(MdibDescriptionModification.Type modType,
                                        AbstractDescriptor descriptor,
                                        @Nullable
                                        AbstractState state)

Add single state descriptor to change set with state information.

Caveat: the change set processor might check descriptor state consistency.

Parameters:

modType - the modification type.

descriptor - the descriptor to add.

state - the state to add.

Returns:

this object for fluent access.

add

public MdibDescriptionModifications add(MdibDescriptionModification.Type modType,
                                        AbstractDescriptor descriptor,
                                        @Nullable
                                        AbstractState state,
                                        @Nullable
                                        String parentHandle)

Add single state descriptor to change set with state information.

Caveat: the change set processor might check descriptor state consistency.

Parameters:

modType - the modification type.

descriptor - the descriptor to add.

state - the state to add.

parentHandle - the parent handle for this modification.

Returns:

this object for fluent access.

add

public MdibDescriptionModifications add(MdibDescriptionModification.Type modType,
                                        AbstractDescriptor descriptor,
                                        List<? extends AbstractMultiState> multiStates)

Add multi state descriptor to change set with state information.

Caveat: the change set processor might check descriptor state consistency.

Parameters:

modType - the modification type.

descriptor - the descriptor to add.

multiStates - the states to add.

Returns:

this object for fluent access.

add

public MdibDescriptionModifications add(MdibDescriptionModification.Type modType,
                                        AbstractDescriptor descriptor,
                                        List<? extends AbstractMultiState> multiStates,
                                        @Nullable
                                        String parentHandle)

Add multi state descriptor to change set with state information.

Caveat: the change set processor might check descriptor state consistency.

Parameters:

modType - the modification type.

descriptor - the descriptor to add.

multiStates - the states to add.

parentHandle - the parent handle for this modification.

Returns:

this object for fluent access.

insert

public MdibDescriptionModifications insert(MdibDescriptionModifications.Entry entry)

Convenient function to insert a descriptor.

Parameters:

entry - bundled information.

Returns:

this object for fluent access.

insert

public MdibDescriptionModifications insert(MdibDescriptionModifications.MultiStateEntry entry)

Convenient function to insert a descriptor.

Parameters:

entry - bundled information.

Returns:

this object for fluent access.

insert

public MdibDescriptionModifications insert(AbstractDescriptor descriptor)

Convenient function to insert a descriptor.

Parameters:

descriptor - the descriptor to insert.

Returns:

this object for fluent access.

insert

public MdibDescriptionModifications insert(AbstractDescriptor descriptor,
                                           @Nullable
                                           String parentHandle)

Convenient function to insert a descriptor.

Parameters:

descriptor - the descriptor to insert.

parentHandle - the parent handle for this modification.

Returns:

this object for fluent access.

insert

public MdibDescriptionModifications insert(AbstractDescriptor descriptor,
                                           AbstractState state)

Convenient function to insert a single state descriptor with state information.

Parameters:

descriptor - the descriptor to insert.

state - the state to insert.

Returns:

this object for fluent access.

insert

public MdibDescriptionModifications insert(AbstractDescriptor descriptor,
                                           AbstractState state,
                                           @Nullable
                                           String parentHandle)

Convenient function to insert a single state descriptor with state information.

Parameters:

descriptor - the descriptor to insert.

state - the state to insert.

parentHandle - the parent handle for this modification.

Returns:

this object for fluent access.

insert

public MdibDescriptionModifications insert(AbstractDescriptor descriptor,
                                           List<? extends AbstractMultiState> multiStates)

Convenient function to insert a multi state descriptor with state information.

Parameters:

descriptor - the descriptor to insert.

multiStates - the states to insert.

Returns:

this object for fluent access.

insert

public MdibDescriptionModifications insert(AbstractDescriptor descriptor,
                                           List<? extends AbstractMultiState> multiStates,
                                           @Nullable
                                           String parentHandle)

Convenient function to insert a multi state descriptor with state information.

Parameters:

descriptor - the descriptor to insert.

multiStates - the states to insert.

parentHandle - the parent handle for this modification.

Returns:

this object for fluent access.

update

public MdibDescriptionModifications update(MdibDescriptionModifications.Entry entry)

Convenient function to update a descriptor.

Parameters:

entry - bundled information.

Returns:

this object for fluent access.

update

public MdibDescriptionModifications update(MdibDescriptionModifications.MultiStateEntry entry)

Convenient function to update a descriptor.

Parameters:

entry - bundled information.

Returns:

this object for fluent access.

update

public MdibDescriptionModifications update(AbstractDescriptor descriptor)

Convenient function to update a descriptor.

Parameters:

descriptor - the descriptor to update.

Returns:

this object for fluent access.

update

public MdibDescriptionModifications update(AbstractDescriptor descriptor,
                                           AbstractState state)

Convenient function to update a single state descriptor with state information.

Parameters:

descriptor - the descriptor to update.

state - the state to update.

Returns:

this object for fluent access.

update

public MdibDescriptionModifications update(AbstractDescriptor descriptor,
                                           List<? extends AbstractMultiState> multiStates)

Convenient function to update a multi state descriptor with state information.

Parameters:

descriptor - the descriptor to update.

multiStates - the states to update.

Returns:

this object for fluent access.

delete

public MdibDescriptionModifications delete(MdibDescriptionModifications.Entry entry)

Convenient function to update a descriptor.

Parameters:

entry - bundled information.

Returns:

this object for fluent access.

delete

public MdibDescriptionModifications delete(AbstractDescriptor descriptor)

Convenient function to delete a descriptor.

Parameters:

descriptor - the descriptor to delete. It is sufficient to set a handle.

Returns:

this object for fluent access.

delete

public MdibDescriptionModifications delete(String handle)

Convenient function to delete a descriptor.

Parameters:

handle - the handle that is used for deletion.

Returns:

this object for fluent access.

isAddedAsInserted

public boolean isAddedAsInserted(String handle)

Checks if a handle was added as inserted.

Parameters:

handle - the handle to seek.

Returns:

true if added as inserted, false otherwise.

isAddedAsUpdated

public boolean isAddedAsUpdated(String handle)

Checks if a handle was added as updated.

Parameters:

handle - the handle to seek.

Returns:

true if added as updated, false otherwise.

isAddedAsDeleted

public boolean isAddedAsDeleted(String handle)

Checks if a handle was added as deleted.

Parameters:

handle - the handle to seek.

Returns:

true if added as deleted, false otherwise.

getModifications

public List<MdibDescriptionModification> getModifications()

Function to get all changes as unmodifiable list.

Returns:

all modifications collected so far.

clear

public void clear()

Empties all modifications.