net.endrealm.realmdrive.interfaces

Interface DriveElement

All Known Subinterfaces:

DriveElementArray, DriveObject

All Known Implementing Classes:

SimpleDriveObject, SimpleElementArray, SimplePrimitiveDriveElement

public interface DriveElement

Author:

johannesjumpertz Defines a drive element. This is the base class for everything retrieved and saved to the backend.

Method Summary

Modifier and Type	Method and Description
DriveElement	add(DriveElement driveElement) Adds drive elements together.
DriveElement	deepClone() Deep clones this element and returns the clone
Boolean	getAsBoolean()
Character	getAsChar()
Double	getAsDouble()
DriveElement	getAsElement()
DriveElementArray	getAsElementArray()
Float	getAsFloat()
Integer	getAsInt()
Long	getAsLong()
DriveObject	getAsObject()
Short	getAsShort()
String	getAsString()
Object	getPrimitiveValue()
HashMap<String,DriveElement>	getSubComponents()
DriveElement	subtract(DriveElement driveElement) Subtracts a Drive element from this element leaving only the difference of this object compared to the parameter element.

Method Detail

getAsBoolean

Boolean getAsBoolean()
              throws ClassCastException,
                     NotAPrimitiveTypeException

Returns:

this element as a Boolean

Throws:

ClassCastException - thrown if the element is not that type

NotAPrimitiveTypeException - thrown if the element is not a primitive type

getAsShort

Short getAsShort()
          throws ClassCastException,
                 NotAPrimitiveTypeException

Returns:

this element as a Short

Throws:

ClassCastException - thrown if the element is not that type

NotAPrimitiveTypeException - thrown if the element is not a primitive type

getAsInt

Integer getAsInt()
          throws ClassCastException,
                 NotAPrimitiveTypeException

Returns:

this element as a Integer

Throws:

ClassCastException - thrown if the element is not that type

NotAPrimitiveTypeException - thrown if the element is not a primitive type

getAsLong

Long getAsLong()
        throws ClassCastException,
               NotAPrimitiveTypeException

Returns:

this element as a Long

Throws:

ClassCastException - thrown if the element is not that type

NotAPrimitiveTypeException - thrown if the element is not a primitive type

getAsChar

Character getAsChar()
             throws ClassCastException,
                    NotAPrimitiveTypeException

Returns:

this element as a Character

Throws:

ClassCastException - thrown if the element is not that type

NotAPrimitiveTypeException - thrown if the element is not a primitive type

getAsString

String getAsString()
            throws ClassCastException,
                   NotAPrimitiveTypeException

Returns:

this element as a String

Throws:

ClassCastException - thrown if the element is not that type

NotAPrimitiveTypeException - thrown if the element is not a primitive type

getAsFloat

Float getAsFloat()
          throws ClassCastException,
                 NotAPrimitiveTypeException

Returns:

this element as a Float

Throws:

ClassCastException - thrown if the element is not that type

NotAPrimitiveTypeException - thrown if the element is not a primitive type

getAsDouble

Double getAsDouble()
            throws ClassCastException,
                   NotAPrimitiveTypeException

Returns:

this element as a Double

Throws:

ClassCastException - thrown if the element is not that type

NotAPrimitiveTypeException - thrown if the element is not a primitive type

getAsObject

DriveObject getAsObject()
                 throws ClassCastException

Returns:

this element as a DriveObject

Throws:

ClassCastException - thrown if the element is not that type

getAsElement

DriveElement getAsElement()
                   throws ClassCastException

Returns:

this element as a DriveElement

Throws:

ClassCastException - thrown if the element is not that type

getAsElementArray

DriveElementArray getAsElementArray()
                             throws ClassCastException

Returns:

this element as a DriveElementArray

Throws:

ClassCastException - thrown if the element is not that type

getPrimitiveValue

Object getPrimitiveValue()

Returns:

primitive value stored in the element. Null if not storing a primitive.

getSubComponents

HashMap<String,DriveElement> getSubComponents()

Returns:

returns a list of sub objects. Null if storing a primitive.

subtract

DriveElement subtract(DriveElement 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.

Parameters:

driveElement - the element to subtract

Returns:

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

add

DriveElement add(DriveElement driveElement)

Adds drive elements together. Following rules apply:

• Changes from the added object will overwrite the values

Parameters:

driveElement - the drive element to add

Returns:

the result

deepClone

DriveElement deepClone()

Deep clones this element and returns the clone

Returns:

the deep clone