org.datanucleus.store.types.wrappers

Class BitSet

java.lang.Object

java.util.BitSet

org.datanucleus.store.types.wrappers.BitSet

All Implemented Interfaces:

Serializable, Cloneable, SCO<BitSet>

public class BitSet
extends BitSet
implements SCO<BitSet>

A mutable second-class BitSet object.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractMemberMetaData	ownerMmd
protected ObjectProvider	ownerOP

Constructor Summary

Constructors

Constructor and Description
BitSet(ObjectProvider op, AbstractMemberMetaData mmd) Creates a BitSet object.

Method Summary

Modifier and Type	Method and Description
void	and(BitSet set)
void	andNot(BitSet set)
void	attachCopy(BitSet value) Method to attached the passed value.
void	clear()
void	clear(int bitIndex)
void	clear(int fromIndex, int toIndex)
Object	clone() Creates and returns a copy of this object.
BitSet	detachCopy(FetchPlanState state) Method to detach a copy.
void	flip(int bitIndex)
void	flip(int fromIndex, int toIndex)
String	getFieldName() Accessor for the field name
Object	getOwner() Accessor for the owner.
BitSet	getValue() Accessor for the unwrapped value that we are wrapping.
void	initialise() Method to initialise the SCO for use, and allowing the SCO to be loaded from the datastore (when we have a backing store).
void	initialise(BitSet set) Method to initialise the SCO for use with the provided initial value.
void	initialise(BitSet newValue, Object oldValue) Method to initialise the SCO for use, where replacing an old value with a new value such as when calling a setter field passing in a new value.
void	makeDirty() Utility to mark the object as dirty
void	or(BitSet set)
void	set(int bitIndex)
void	set(int bitIndex, boolean value)
void	set(int fromIndex, int toIndex)
void	set(int fromIndex, int toIndex, boolean value)
void	unsetOwner() Utility to unset the owner.
protected Object	writeReplace() The writeReplace method is called when ObjectOutputStream is preparing to write the object to the stream.
void	xor(BitSet set)

Methods inherited from class java.util.BitSet

cardinality, equals, get, get, hashCode, intersects, isEmpty, length, nextClearBit, nextSetBit, previousClearBit, previousSetBit, size, stream, toByteArray, toLongArray, toString, valueOf, valueOf, valueOf, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ownerOP

protected transient ObjectProvider ownerOP

ownerMmd

protected transient AbstractMemberMetaData ownerMmd

Constructor Detail

BitSet

public BitSet(ObjectProvider op,
              AbstractMemberMetaData mmd)

Creates a BitSet object. Assigns owning object and field name.

Parameters:

op - ObjectProvider for the owning object

mmd - Metadata for the member

Method Detail

initialise

public void initialise()

Description copied from interface: SCO

Method to initialise the SCO for use, and allowing the SCO to be loaded from the datastore (when we have a backing store). This can be utilised to perform any eager loading of information from the datastore.

Specified by:

initialise in interface SCO<BitSet>

initialise

public void initialise(BitSet newValue,
                       Object oldValue)

Description copied from interface: SCO

Method to initialise the SCO for use, where replacing an old value with a new value such as when calling a setter field passing in a new value. Note that oldValue is marked as Object since for cases where the member type is Collection the newValue could be, for example, ArrayList, and the oldValue of type Collection (representing null).

Specified by:

initialise in interface SCO<BitSet>

Parameters:

newValue - New value (to wrap)

oldValue - Old value (to use in deciding what needs deleting etc)

initialise

public void initialise(BitSet set)

Description copied from interface: SCO

Method to initialise the SCO for use with the provided initial value. This is used, for example, when retrieving the field from the datastore and setting it in the persistable object.

Specified by:

initialise in interface SCO<BitSet>

Parameters:

set - the object from which to copy the value.

getValue

public BitSet getValue()

Accessor for the unwrapped value that we are wrapping.

Specified by:

getValue in interface SCO<BitSet>

Returns:

The unwrapped value

unsetOwner

public void unsetOwner()

Utility to unset the owner.

Specified by:

unsetOwner in interface SCO<BitSet>

getOwner

public Object getOwner()

Accessor for the owner.

Specified by:

getOwner in interface SCO<BitSet>

Returns:

The owner

getFieldName

public String getFieldName()

Accessor for the field name

Specified by:

getFieldName in interface SCO<BitSet>

Returns:

The field name

makeDirty

public void makeDirty()

Utility to mark the object as dirty

detachCopy

public BitSet detachCopy(FetchPlanState state)

Method to detach a copy.

Specified by:

detachCopy in interface SCO<BitSet>

Parameters:

state - State for detachment process

Returns:

A copy of the object

attachCopy

public void attachCopy(BitSet value)

Method to attached the passed value.

Specified by:

attachCopy in interface SCO<BitSet>

Parameters:

value - The new value

clone

public Object clone()

Creates and returns a copy of this object.

Mutable second-class Objects are required to provide a public clone method in order to allow for copying persistable objects. In contrast to Object.clone(), this method must not throw a CloneNotSupportedException.

Specified by:

clone in interface SCO<BitSet>

Overrides:

clone in class BitSet

Returns:

A clone of the object

writeReplace

protected Object writeReplace()
                       throws ObjectStreamException

The writeReplace method is called when ObjectOutputStream is preparing to write the object to the stream. The ObjectOutputStream checks whether the class defines the writeReplace method. If the method is defined, the writeReplace method is called to allow the object to designate its replacement in the stream. The object returned should be either of the same type as the object passed in or an object that when read and resolved will result in an object of a type that is compatible with all references to the object.

Returns:

the replaced object

Throws:

ObjectStreamException - if an error occurs

and

public void and(BitSet set)

Overrides:

and in class BitSet

andNot

public void andNot(BitSet set)

Overrides:

andNot in class BitSet

clear

public void clear(int bitIndex)

Overrides:

clear in class BitSet

or

public void or(BitSet set)

Overrides:

or in class BitSet

set

public void set(int bitIndex)

Overrides:

set in class BitSet

xor

public void xor(BitSet set)

Overrides:

xor in class BitSet

clear

public void clear()

Overrides:

clear in class BitSet

clear

public void clear(int fromIndex,
                  int toIndex)

Overrides:

clear in class BitSet

flip

public void flip(int fromIndex,
                 int toIndex)

Overrides:

flip in class BitSet

flip

public void flip(int bitIndex)

Overrides:

flip in class BitSet

set

public void set(int bitIndex,
                boolean value)

Overrides:

set in class BitSet

set

public void set(int fromIndex,
                int toIndex,
                boolean value)

Overrides:

set in class BitSet

set

public void set(int fromIndex,
                int toIndex)

Overrides:

set in class BitSet