com.aspc.DBObj.Internal

Class MutableArrayValueData

java.lang.Object

com.aspc.DBObj.Internal.MutableArrayValueData

public final class MutableArrayValueData
extends java.lang.Object

Array of values
THREAD MODE: SINGLE-THREADED

Since:

5 May 2007

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
DBField	field the base field.
DBObjectHelper	helper the helper
DBObject	obj the base object

Constructor Summary

Constructors

Constructor and Description
MutableArrayValueData(DBObject obj, DBField field, StoredArrayValue store, DBObjectHelper helper, DBObjectHelper copyFrom) create a mutable array value based on another.

Method Summary

Modifier and Type	Method and Description
void	add(MutableArrayValue mav, int index, java.lang.Object element)
boolean	add(MutableArrayValue mav, java.lang.Object e)
boolean	addAll(MutableArrayValue mav, java.util.Collection c)
boolean	addAll(MutableArrayValue mav, int index, java.util.Collection c)
void	clear(MutableArrayValue mav)
boolean	contains(java.lang.Object o)
static MutableArrayValueData	find(DBObjectHelper helper, DBField field, StoredArrayValue store)
java.lang.Object	get(int pos) get the object at the position
DBObject	getDBObject() get the base object
int	getOriginalSeq(int pos) get the original sequence number.
boolean	hasChanged() Has this been changed ?
int	indexOf(java.lang.Object o)
int	lastIndexOf(java.lang.Object o)
java.util.ListIterator	listIterator(int index) list iterator
java.util.ListIterator	listIterator(MutableArrayValue mav)
void	markAsSaved()
java.lang.Object	rawGet(int pos) get the object at the position
static MutableArrayValueData	reloadData(DBObject obj, DBField field, DBObjectHelper helper, StoredArrayValue store) reload the data
java.lang.Object	remove(MutableArrayValue mav, int index)
boolean	remove(MutableArrayValue mav, java.lang.Object o)
boolean	removeAll(java.util.Collection c)
boolean	retainAll(java.util.Collection c)
java.lang.Object	set(MutableArrayValue mav, int pos, java.lang.Object inValue) set the value
int	size()
java.util.List	subList(int fromIndex, int toIndex) sub list
java.lang.Object[]	toArray()
java.lang.Object[]	toArray(java.lang.Object[] array) make a array
java.lang.String	toString() to String

Methods inherited from class java.lang.Object

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

Field Detail

helper

public final DBObjectHelper helper

the helper

obj

public final DBObject obj

the base object

field

public final DBField field

the base field.

Constructor Detail

MutableArrayValueData

public MutableArrayValueData(@Nonnull
                             DBObject obj,
                             @Nonnull
                             DBField field,
                             @Nullable
                             StoredArrayValue store,
                             @Nonnull
                             DBObjectHelper helper,
                             @Nullable
                             DBObjectHelper copyFrom)

create a mutable array value based on another.

Parameters:

obj - the object

field - the field

helper - the helper

store - the store to be based on.

copyFrom - copy from

Method Detail

getDBObject

@CheckReturnValue
 @Nonnull
public DBObject getDBObject()

get the base object

Returns:

the object

hasChanged

@CheckReturnValue
public boolean hasChanged()

Has this been changed ?

Returns:

true if changed.

getOriginalSeq

@CheckReturnValue
public int getOriginalSeq(@Nonnegative
                                            int pos)

get the original sequence number.

Parameters:

pos - the position to fetch.

Returns:

the sequence number.

reloadData

@Nonnull
 @CheckReturnValue
public static MutableArrayValueData reloadData(DBObject obj,
                                                                           DBField field,
                                                                           DBObjectHelper helper,
                                                                           StoredArrayValue store)

reload the data

Parameters:

obj - the object

field - the field

helper - the helper

store - the store

Returns:

the array value

find

@Nullable
 @CheckReturnValue
public static MutableArrayValueData find(@Nonnull
                                                                      DBObjectHelper helper,
                                                                      @Nonnull
                                                                      DBField field,
                                                                      StoredArrayValue store)

Parameters:

helper - the helper

field - the field

store - the store

Returns:

the value

get

@Nullable
 @CheckReturnValue
public java.lang.Object get(@Nonnegative
                                                         int pos)

get the object at the position

Parameters:

pos - the position

Returns:

the value

rawGet

@Nullable
 @CheckReturnValue
public java.lang.Object rawGet(@Nonnegative
                                                            int pos)

get the object at the position

Parameters:

pos - the position

Returns:

the value

set

@Nullable
public java.lang.Object set(MutableArrayValue mav,
                                      @Nonnegative
                                      int pos,
                                      @Nonnull
                                      java.lang.Object inValue)

set the value

Parameters:

mav - the real array value

pos - the position

inValue - the value

Returns:

the previous value.

markAsSaved

public void markAsSaved()

size

@CheckReturnValue
 @Nonnegative
public int size()

Returns:

the size

contains

@CheckReturnValue
public boolean contains(java.lang.Object o)

Parameters:

o - object to check

Returns:

true if contained

toArray

@CheckReturnValue
 @Nonnull
public java.lang.Object[] toArray()

Returns:

the array

toString

@CheckReturnValue
 @Nonnull
public java.lang.String toString()

to String

Overrides:

toString in class java.lang.Object

Returns:

the string

add

public boolean add(MutableArrayValue mav,
                   java.lang.Object e)

Parameters:

mav - the base mutable array value

e - the object

Returns:

true

remove

public boolean remove(MutableArrayValue mav,
                      java.lang.Object o)

Parameters:

mav - the base mutable array value

o - the object to remove

Returns:

true if replaced

addAll

public boolean addAll(MutableArrayValue mav,
                      java.util.Collection c)

Parameters:

mav - the base mutable array value

c - the collection

Returns:

add them all.

addAll

public boolean addAll(MutableArrayValue mav,
                      @Nonnegative
                      int index,
                      java.util.Collection c)

Parameters:

mav - the base mutable array value

index - the place

c - the collection

Returns:

true if all added.

removeAll

public boolean removeAll(java.util.Collection c)

Parameters:

c - the collection

Returns:

true if all removed.

retainAll

public boolean retainAll(java.util.Collection c)

Parameters:

c - the collection

Returns:

true if removed

clear

public void clear(MutableArrayValue mav)

Parameters:

mav - the base mutable array value

add

public void add(MutableArrayValue mav,
                @Nonnegative
                int index,
                java.lang.Object element)

Parameters:

mav - the base mutable array value

index - to location

element - the element to add

remove

public java.lang.Object remove(MutableArrayValue mav,
                               @Nonnegative
                               int index)

Parameters:

mav - the base mutable array value

index - from location

Returns:

the object that was removed.

indexOf

public int indexOf(java.lang.Object o)

Parameters:

o - the object to check

Returns:

the location

lastIndexOf

public int lastIndexOf(java.lang.Object o)

Parameters:

o - object to check

Returns:

the last index

listIterator

public java.util.ListIterator listIterator(MutableArrayValue mav)

Parameters:

mav - the base mutable array value

Returns:

the result

listIterator

public java.util.ListIterator listIterator(int index)

list iterator

Parameters:

index - from

Returns:

the iterator

subList

public java.util.List subList(int fromIndex,
                              int toIndex)

sub list

Parameters:

fromIndex - from

toIndex - to

Returns:

the sub list

toArray

@CheckReturnValue
 @Nonnull
public java.lang.Object[] toArray(@Nonnull
                                                              java.lang.Object[] array)

make a array

Parameters:

array - the target array

Returns:

the new array