org.jpox.sco
Class BitSet

java.lang.Object
  java.util.BitSet
      org.jpox.sco.BitSet

All Implemented Interfaces:

java.lang.Cloneable, SCO, java.io.Serializable

Direct Known Subclasses:

BitSetJDK14

public class BitSet

extends java.util.BitSet

implements SCO

A mutable second-class BitSet object.

Version:

$Revision: 1.13 $

See Also:

Serialized Form

Constructor Summary

BitSet(StateManager ownerSM, java.lang.String fieldName)
Creates a BitSet object.

Method Summary

void	and(java.util.BitSet set)
void	andNot(java.util.BitSet set)
void	attachCopy(java.lang.Object value) Method to attached the passed value.
void	clear(int bitIndex)
java.lang.Object	clone() Creates and returns a copy of this object.
void	detach(FetchPlanState state) Method to detach the BitSet.
java.lang.Object	detachCopy(FetchPlanState state) Method to detach a copy.
java.lang.String	getFieldName() Accessor for the field name
java.lang.Object	getOwner() Accessor for the owner.
void	makeDirty() Utility to mark the object as dirty
void	makeTransient(FetchPlanState state) Method to make transient this object.
void	or(java.util.BitSet set)
void	runReachability(java.util.Set reachables) Method to run reachability on this SCO.
void	set(int bitIndex)
void	setValueFrom(java.lang.Object o, boolean forUpdate) Mutator for the value, using an object.
void	unsetOwner() Utility to unset the owner.
protected java.lang.Object	writeReplace() The writeReplace method is called when ObjectOutputStream is preparing to write the object to the stream.
void	xor(java.util.BitSet set)

Methods inherited from class java.util.BitSet

cardinality, clear, clear, equals, flip, flip, get, get, hashCode, intersects, isEmpty, length, nextClearBit, nextSetBit, set, set, set, size, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BitSet

public BitSet(StateManager ownerSM,
              java.lang.String fieldName)

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

Parameters:

ownerSM - the owning object

fieldName - the owning field name

Method Detail

setValueFrom

public void setValueFrom(java.lang.Object o,
                         boolean forUpdate)

Mutator for the value, using an object.

Specified by:

setValueFrom in interface SCO

Parameters:

o - The Object

forUpdate - Whether to update the object in the datastore with this value

unsetOwner

public void unsetOwner()

Utility to unset the owner.

Specified by:

unsetOwner in interface SCO

getOwner

public java.lang.Object getOwner()

Accessor for the owner.

Specified by:

getOwner in interface SCO

Returns:

The owner

getFieldName

public java.lang.String getFieldName()

Accessor for the field name

Specified by:

getFieldName in interface SCO

Returns:

The field name

makeDirty

public void makeDirty()

Utility to mark the object as dirty

runReachability

public void runReachability(java.util.Set reachables)

Method to run reachability on this SCO.

Specified by:

runReachability in interface SCO

Parameters:

reachables - List of StateManagers reachable so far

makeTransient

public void makeTransient(FetchPlanState state)

Method to make transient this object.

Specified by:

makeTransient in interface SCO

Parameters:

state - State for the fetchplan process

detach

public void detach(FetchPlanState state)

Method to detach the BitSet.

Specified by:

detach in interface SCO

Parameters:

state - State for the detachment process

detachCopy

public java.lang.Object detachCopy(FetchPlanState state)

Method to detach a copy.

Specified by:

detachCopy in interface SCO

Parameters:

state - State for detachment process

Returns:

A copy of the object

attachCopy

public void attachCopy(java.lang.Object value)

Method to attached the passed value.

Specified by:

attachCopy in interface SCO

Parameters:

value - The new value

clone

public java.lang.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 PersistenceCapable objects. In contrast to Object.clone(), this method must not throw a CloneNotSupportedException.

Specified by:

clone in interface SCO

Returns:

A clone of the object

writeReplace

protected java.lang.Object writeReplace()
                                 throws java.io.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:

java.io.ObjectStreamException

and

public void and(java.util.BitSet set)

andNot

public void andNot(java.util.BitSet set)

clear

public void clear(int bitIndex)

or

public void or(java.util.BitSet set)

set

public void set(int bitIndex)

xor

public void xor(java.util.BitSet set)