net.endrealm.realmdrive.interfaces

Interface DriveObject

All Superinterfaces:

DriveElement

All Known Implementing Classes:

SimpleDriveObject

public interface DriveObject
extends DriveElement

Author:

johannesjumpertz Defines a drive object. Used to contain multiple drive Elements

Method Summary

Modifier and Type	Method and Description
DriveObject	deepClone() Deep clones this element and returns the clone
DriveElement	get(String key) Retrieves an item from the list
DriveObject	getAsObject(String key) Retrieves an item from the list
<T> T	getAsTypedObject(Class<T> clazz) Returns this object converted to an object of the specified type
DriveObjectFactory	getFactory() The factory this object uses to construct sub objects and clones
boolean	isEmpty() Checks if this object is empty
void	setObject(String key, DriveElement element) Writes an element to the list
void	setPrimitive(String key, Object object) Writes an primitive element to the list
DriveObject	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(String key)

Retrieves an item from the list

Parameters:

key - used to identify an item

Returns:

a drive element. Null if not found

getAsObject

DriveObject getAsObject(String key)

Retrieves an item from the list

Parameters:

key - used to identify an item

Returns:

a drive object. Null if not found

setObject

void setObject(String key,
               DriveElement element)
        throws ObjectReadOnlyException

Writes an element to the list

Parameters:

key - key to affiliate the element with

element - element to store

Throws:

ObjectReadOnlyException - thrown if this object does not support writing

setPrimitive

void setPrimitive(String key,
                  Object object)
           throws ObjectReadOnlyException,
                  NotAPrimitiveTypeException

Writes an primitive element to the list

Parameters:

key - key to affiliate the element with

object - primitive type object

Throws:

NotAPrimitiveTypeException - thrown if object parameter is not a primitive type

ObjectReadOnlyException - thrown if this object does not support writing

getAsTypedObject

<T> T getAsTypedObject(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.

isEmpty

boolean isEmpty()

Checks if this object is empty

Returns:

true if object does not contain any values

deepClone

DriveObject 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

DriveObject 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

getFactory

DriveObjectFactory getFactory()

The factory this object uses to construct sub objects and clones

Returns:

the objects factory