org.qedeq.kernel.se.dto.list
Class DefaultElementList

java.lang.Object
  org.qedeq.kernel.se.dto.list.DefaultElementList

All Implemented Interfaces:

Element, ElementList

public final class DefaultElementList
extends java.lang.Object
implements ElementList

Every Operator must inherit from this class. Its main function is to provide the standard implementation of equals(java.lang.Object) and hashCode().

Author:

Michael Meyling

Constructor Summary

DefaultElementList(java.lang.String operator)
Constructs an element list with no elements.

DefaultElementList(java.lang.String operator, Element[] elements)
Constructs an element list.

Method Summary

void	add(Element element) TODO 20110327 m31: do we have to use modifying methods like this or ElementList.remove(int) and so on? If we need them we have to make a deep copy.
Element	copy() Returns an identical object.
boolean	equals(java.lang.Object object) Is this object equal to the given one?
Atom	getAtom() Return this element as an Atom.
Element	getElement(int i) Get the requested argument.
java.util.List	getElements() Get all arguments as an list.
ElementList	getList() Return this element as an ElementList.
java.lang.String	getOperator() Get the operator.
int	hashCode() Calculates the hash code.
void	insert(int position, Element element) Inserts an element to specified position.
boolean	isAtom() Is this an atom?
boolean	isList() Is this an ElementList?
void	remove(int i) Deletes an element of element list.
Element	replace(Element search, Element replacement) Creates and returns a copy of this object, but replaces anything that Element.equals(java.lang.Object) argument with a Element.copy() of replacement.
void	replace(int position, Element element) Replaces an element at specified position.
int	size() Get the number of arguments.
java.lang.String	toString() Get show this in String form.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultElementList

public DefaultElementList(java.lang.String operator)

Constructs an element list with no elements.

Parameters:

operator - Operator name.

Throws:

java.lang.IllegalArgumentException - Element or operator was a NullPointer.

DefaultElementList

public DefaultElementList(java.lang.String operator,
                          Element[] elements)

Constructs an element list.

Parameters:

operator - Operator name.

elements - the elements to make a list of

Throws:

java.lang.IllegalArgumentException - Element or operator was a NullPointer.

Method Detail

isAtom

public final boolean isAtom()

Description copied from interface: Element

Is this an atom?

Specified by:

isAtom in interface Element

Returns:

true if this is an instance of Atom.

getAtom

public final Atom getAtom()

Description copied from interface: Element

Return this element as an Atom.

Specified by:

getAtom in interface Element

Returns:

This is an instance of Atom.

isList

public final boolean isList()

Description copied from interface: Element

Is this an ElementList?

Specified by:

isList in interface Element

Returns:

true if this is an instance of ElementList.

getList

public final ElementList getList()

Description copied from interface: Element

Return this element as an ElementList.

Specified by:

getList in interface Element

Returns:

This as an instance of ElementList.

getOperator

public final java.lang.String getOperator()

Description copied from interface: ElementList

Get the operator.

Specified by:

getOperator in interface ElementList

Returns:

Operator.

size

public final int size()

Description copied from interface: ElementList

Get the number of arguments.

Specified by:

size in interface ElementList

Returns:

Number of arguments.

getElement

public final Element getElement(int i)

Description copied from interface: ElementList

Get the requested argument.

Specified by:

getElement in interface ElementList

Parameters:

i - Number of argument (starting with 0).

Returns:

i-th part formula.

getElements

public final java.util.List getElements()

Description copied from interface: ElementList

Get all arguments as an list.

Specified by:

getElements in interface ElementList

Returns:

All elements.

equals

public final boolean equals(java.lang.Object object)

Description copied from interface: Element

Is this object equal to the given one?

Specified by:

equals in interface Element

Overrides:

equals in class java.lang.Object

Parameters:

object - to compare with

Returns:

Is object equal to this one?

copy

public final Element copy()

Description copied from interface: Element

Returns an identical object. This is a deep copy so later changes of the original element (or its sub parts) are not reflected in the copy.

Specified by:

copy in interface Element

Returns:

Copy of this object.

replace

public final Element replace(Element search,
                             Element replacement)

Description copied from interface: Element

Creates and returns a copy of this object, but replaces anything that Element.equals(java.lang.Object) argument with a Element.copy() of replacement.

Specified by:

replace in interface Element

Parameters:

search - Check for occurrence of this.

replacement - Replace with this.

Returns:

Copy with replacements.

add

public final void add(Element element)

Description copied from interface: ElementList

TODO 20110327 m31: do we have to use modifying methods like this or ElementList.remove(int) and so on? If we need them we have to make a deep copy. Otherwise we can save lots of space! Adds an element to end of list.

Specified by:

add in interface ElementList

Parameters:

element - Element to add.

insert

public final void insert(int position,
                         Element element)

Description copied from interface: ElementList

Inserts an element to specified position.

Specified by:

insert in interface ElementList

Parameters:

position - Position of element to add.

element - Element to add.

replace

public final void replace(int position,
                          Element element)

Description copied from interface: ElementList

Replaces an element at specified position.

Specified by:

replace in interface ElementList

Parameters:

position - Position of element to replace.

element - Replacement element.

remove

public final void remove(int i)

Description copied from interface: ElementList

Deletes an element of element list.

Specified by:

remove in interface ElementList

Parameters:

i - Position of element to remove.

hashCode

public final int hashCode()

Description copied from interface: Element

Calculates the hash code.

Specified by:

hashCode in interface Element

Overrides:

hashCode in class java.lang.Object

Returns:

Hash code of this object

toString

public final java.lang.String toString()

Description copied from interface: Element

Get show this in String form.

Specified by:

toString in interface Element

Overrides:

toString in class java.lang.Object

Returns:

Readable list.