Interface BundleDelta
- All Superinterfaces:
Comparable<BundleDelta>
BundleDeltas represent the changes related to an individual bundle between
two states.
This interface is not intended to be implemented by clients. The
StateObjectFactory
should be used to construct instances.
- Since:
- 3.1
- Restriction:
- This interface is not intended to be implemented by clients.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Delta type constant (bit mask) indicating that the bundle has been added to the new state.static final int
Deprecated.this type is no longer validstatic final int
Deprecated.this type is no longer validstatic final int
Delta type constant (bit mask) indicating that the this bundle has completed a pending removal.static final int
Delta type constant (bit mask) indicating that the this bundle is pending a removal.static final int
Delta type constant (bit mask) indicating that the bundle is no longer present in the new state.static final int
Delta type constant (bit mask) indicating that the bundle has become resolved in the new state.static final int
Delta type constant (bit mask) indicating that the bundle has become unresolved in the new state.static final int
Delta type constant (bit mask) indicating that the bundle has been updated between the old and new state. -
Method Summary
Modifier and TypeMethodDescriptionint
compareTo
(BundleDelta obj) Answers an integer indicating the relative positions of the receiver and the argument in the natural order of elements of the receiver's class.Returns the BundleDescription that this bundle delta is for.int
getType()
Returns the type of change which occured.
-
Field Details
-
ADDED
static final int ADDEDDelta type constant (bit mask) indicating that the bundle has been added to the new state.- See Also:
-
REMOVED
static final int REMOVEDDelta type constant (bit mask) indicating that the bundle is no longer present in the new state.- See Also:
-
UPDATED
static final int UPDATEDDelta type constant (bit mask) indicating that the bundle has been updated between the old and new state. Note that an update delta may in fact represent a downgrading of the bundle to a previous version.- See Also:
-
RESOLVED
static final int RESOLVEDDelta type constant (bit mask) indicating that the bundle has become resolved in the new state.- See Also:
-
UNRESOLVED
static final int UNRESOLVEDDelta type constant (bit mask) indicating that the bundle has become unresolved in the new state. Note that newly added bundles are unresolved by default and as such, do not transition to unresolved state so this flag is not set.- See Also:
-
LINKAGE_CHANGED
static final int LINKAGE_CHANGEDDeprecated.this type is no longer validDelta type constant (bit mask) indicating that the bundles and packages which this bundle requires/imports (respectively) have changed in the new state.- See Also:
-
OPTIONAL_LINKAGE_CHANGED
static final int OPTIONAL_LINKAGE_CHANGEDDeprecated.this type is no longer validDelta type constant (bit mask) indicating that the bundles which this bundle optionally requires have changed in the new state.- See Also:
-
REMOVAL_PENDING
static final int REMOVAL_PENDINGDelta type constant (bit mask) indicating that the this bundle is pending a removal. Note that bundles with this flag set will also have theREMOVED
flag set. A bundle will have this flag set if it has been removed from the state but has other existing bundles in the state that depend on it.- See Also:
-
REMOVAL_COMPLETE
static final int REMOVAL_COMPLETEDelta type constant (bit mask) indicating that the this bundle has completed a pending removal. A bundle will complete a pending removal only after it has been re-resolved by the resolver.- See Also:
-
-
Method Details
-
getBundle
BundleDescription getBundle()Returns the BundleDescription that this bundle delta is for.- Returns:
- the BundleDescription that this bundle delta is for.
-
getType
int getType()Returns the type of change which occured. The return value is composed of by bit-wise masking the relevant flags from the set ADDED, REMOVED, UPDATED, RESOLVED, UNRESOLVED, LINKAGE_CHANGED, REMOVAL_PENDING, REMOVAL_COMPLETE. Note that bundle start and stop state changes are not captured in the delta as they do not represent structural changes but rather transient runtime states.- Returns:
- the type of change which occured
-
compareTo
Answers an integer indicating the relative positions of the receiver and the argument in the natural order of elements of the receiver's class.The natural order of elements is determined by the bundle id of the BundleDescription that this bundle delta is for.
- Specified by:
compareTo
in interfaceComparable<BundleDelta>
- Parameters:
obj
- another BundleDelta an object to compare the receiver to- Returns:
- int which should be <0 if the receiver should sort before the argument, 0 if the receiver should sort in the same position as the argument, and >0 if the receiver should sort after the argument.
- Throws:
ClassCastException
- if the argument can not be converted into something comparable with the receiver.- Since:
- 3.7
-