net.endrealm.realmdrive.interfaces

Interface DriveElementArray

All Superinterfaces:

DriveElement

All Known Implementing Classes:

SimpleElementArray

public interface DriveElementArray
extends DriveElement

Author:

johannesjumpertz Defines a drive element array. Used to contain multiple drive Elements

Method Summary

Modifier and Type	Method and Description
void	addObject(DriveElement element) Adds an element to the end of the array
void	addObject(int num, DriveElement element) Writes an element to the list
void	addPrimitive(int num, Object object) Writes an primitive element to the list
void	addPrimitive(Object object) Adds an primitive element to the end of the array
DriveElementArray	deepClone() Deep clones this element and returns the clone
DriveElement	get(int num) Retrieves an item from the list
DriveObject	getAsObject(int num) Retrieves an item from the list
<T> List<T>	getAsTypedList(Class<T> clazz) Returns this object converted to an object of the specified type
List<DriveElement>	getContents() Returns all contents as a mutable list
int	getSize()
DriveElementArray	subtract(DriveElement driveElement) Subtracts a Drive element from this element leaving only the difference of this object compared to the parameter element.

Methods inherited from interface net.endrealm.realmdrive.interfaces.DriveElement

add, getAsBoolean, getAsChar, getAsDouble, getAsElement, getAsElementArray, getAsFloat, getAsInt, getAsLong, getAsObject, getAsShort, getAsString, getPrimitiveValue, getSubComponents

Method Detail

get

DriveElement get(int num)

Retrieves an item from the list

Parameters:

num - used to identify an item

Returns:

a drive element. Null if not found

getAsObject

DriveObject getAsObject(int num)

Retrieves an item from the list

Parameters:

num - used to identify an item

Returns:

a drive object. Null if not found

addObject

void addObject(int num,
               DriveElement element)
        throws ObjectReadOnlyException

Writes an element to the list

Parameters:

num - position to insert at

element - element to store

Throws:

ObjectReadOnlyException - thrown if this object does not support writing

addPrimitive

void addPrimitive(int num,
                  Object object)
           throws ObjectReadOnlyException,
                  NotAPrimitiveTypeException

Writes an primitive element to the list

Parameters:

num - position to insert at

object - primitive type object

Throws:

NotAPrimitiveTypeException - thrown if object parameter is not a primitive type

ObjectReadOnlyException - thrown if this object does not support writing

getAsTypedList

<T> List<T> getAsTypedList(Class<T> clazz)
                    throws ClassCastException

Returns this object converted to an object of the specified type

Type Parameters:

T - type to convert object to

Parameters:

clazz - type to convert object to

Returns:

converted object

Throws:

ClassCastException - thrown if this object can not be converted into the specified object.

getContents

List<DriveElement> getContents()

Returns all contents as a mutable list

Returns:

contents

addObject

void addObject(DriveElement element)

Adds an element to the end of the array

Parameters:

element - element to be added

addPrimitive

void addPrimitive(Object object)
           throws NotAPrimitiveTypeException

Adds an primitive element to the end of the array

Parameters:

object - element to be added

Throws:

NotAPrimitiveTypeException - thrown if object parameter is not a primitive type

deepClone

DriveElementArray deepClone()

Description copied from interface: DriveElement

Deep clones this element and returns the clone

Specified by:

deepClone in interface DriveElement

Returns:

the deep clone

subtract

DriveElementArray subtract(DriveElement driveElement)

Description copied from interface: DriveElement

Subtracts a Drive element from this element leaving only the difference of this object compared to the parameter element. Using this on non empty lists might break them. If there is no difference null is returned.

Specified by:

subtract in interface DriveElement

Parameters:

driveElement - the element to subtract

Returns:

difference of this object to the other. If no difference null is returned

getSize

int getSize()