Package net.ssehub.easy.varModel.model.values

Class ContainerValue

java.lang.Object

net.ssehub.easy.varModel.model.values.Value

net.ssehub.easy.varModel.model.values.StructuredValue

net.ssehub.easy.varModel.model.values.ContainerValue

All Implemented Interfaces:

java.lang.Cloneable

public class ContainerValue
extends StructuredValue
implements java.lang.Cloneable

ContainerValue class.

Author:

Marcel Lueder, El-Sharkawy, Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<Value>	nestedElements

Constructor Summary

Constructors

Modifier	Constructor	Description
(package private)	ContainerValue()	Constructor for serialization.
(package private)	ContainerValue(Container container)	Constructor for a new ContainerValue.
	ContainerValue(Container container, boolean check, java.lang.Object... value)	Constructor for a new ContainerValue.
(package private)	ContainerValue(Container container, java.lang.Object... value)	Constructor for a new ContainerValue.
protected	ContainerValue(Container container, ContainerValue source)	Creates a new compound value by copying the values from source.

Method Summary

Modifier and Type	Method	Description
void	accept(IValueVisitor visitor)	Abstract accept method.
void	addElement(int pos, Value value)	Adds a value at the position pos.
void	addElement(Value value)	Adds an element to this container.
private void	checkContainedType(Value value)	Checks whether value is type compliant with the getContainedType().
void	clear()	Clears all elements.
ContainerValue	clone()	Clones the this value.
void	copyValuesFrom(ContainerValue source)	Copies the values from source.
private void	doAll(java.util.HashSet<Value> set, boolean add)	Adds/removes all elements to/from set.
private boolean	duplicateValues(java.lang.Object[] values)	Checks whether the given array has duplicated values and this value belongs to a set.
boolean	equals(java.lang.Object other)
boolean	equalsPartially(Value value)	Returns whether the provided value is partially equal to this value, i.e., whether the nested elements of value (if they exist) have the same contents as in this value.
IDatatype	getContainedType()	Returns the data type explicitly contained in this value.
Value	getElement(int index)	Returns the specified element.
int	getElementSize()	Returns the number of elements in this container.
java.lang.Object	getValue()	Getter for the value.
int	hashCode()
int	indexOf(Value value)	Returns the (first) index of the specified (nested) value.
boolean	isFullyConfigured()	Method to check, whether each object of the Value has a value assigned.
private boolean	isSetValue()	Checks whether this value belongs to a Set or an Sequence.
java.util.Iterator<Value>	iterator()	Returns an iterator over all values.
java.lang.String	nestedValuesToString()	Turns the nested values into a string.
void	removeElement(int index)	Removes a value from this container.
void	removeElement(Value value)	Removes a value from this container.
void	setValue(int index, Value nestedValue)	Sets the value for an already existent nested value.
void	setValue(java.lang.Object value)	Abstract setValue-method.
java.lang.String	toString()

Methods inherited from class net.ssehub.easy.varModel.model.values.StructuredValue

getValueParent, isConfigured, setValueParent

Methods inherited from class net.ssehub.easy.varModel.model.values.Value

equals, equalsPartially, getType, stringValueOf

Methods inherited from class java.lang.Object

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

Field Detail

nestedElements

private java.util.List<Value> nestedElements

Constructor Detail

ContainerValue

ContainerValue()

Constructor for serialization.

ContainerValue

ContainerValue(Container container,
               java.lang.Object... value)
        throws ValueDoesNotMatchTypeException

Constructor for a new ContainerValue.

Parameters:

container - the container which extends this ContainerValue

value - the value(s) to be assigned to this container

Throws:

ValueDoesNotMatchTypeException - if the given value does not match this type

ContainerValue

public ContainerValue(Container container,
                      boolean check,
                      java.lang.Object... value)
               throws ValueDoesNotMatchTypeException

Constructor for a new ContainerValue.

Parameters:

container - the container which extends this ContainerValue

check - for duplicates

value - the value(s) to be assigned to this container

Throws:

ValueDoesNotMatchTypeException - if the given value does not match this type

ContainerValue

protected ContainerValue(Container container,
                         ContainerValue source)
                  throws ValueDoesNotMatchTypeException

Creates a new compound value by copying the values from source.

Parameters:

container - the container type

source - the value which acts as a source for data

Throws:

ValueDoesNotMatchTypeException - if the given value does not match this type

ContainerValue

ContainerValue(Container container)

Constructor for a new ContainerValue.

Parameters:

container - the container which extends this ContainerValue

Method Detail

getContainedType

public IDatatype getContainedType()

Description copied from class: Value

Returns the data type explicitly contained in this value. This is typically a meta value, i.e. a type expression.

Overrides:

getContainedType in class Value

Returns:

the contained type or null if there is none

getValue

public java.lang.Object getValue()

Getter for the value. Do not use! This value instance has substructures and does not hold a single value. Use getElement(int) instead.

Specified by:

getValue in class Value

Returns:

null always

nestedValuesToString

public java.lang.String nestedValuesToString()

Turns the nested values into a string.

Returns:

the nested values as string

toString

public java.lang.String toString()

Overrides:

toString in class Value

accept

public void accept(IValueVisitor visitor)

Description copied from class: Value

Abstract accept method.

Specified by:

accept in class Value

Parameters:

visitor - The visitor

setValue

public void setValue(java.lang.Object value)
              throws ValueDoesNotMatchTypeException

Description copied from class: Value

Abstract setValue-method.

Specified by:

setValue in class Value

Parameters:

value - the value to set.

Throws:

ValueDoesNotMatchTypeException - if the given value does not match this type

isFullyConfigured

public boolean isFullyConfigured()

Description copied from class: StructuredValue

Method to check, whether each object of the Value has a value assigned.

Specified by:

isFullyConfigured in class StructuredValue

Returns:

true if all sub-elements are configured, else false

copyValuesFrom

public void copyValuesFrom(ContainerValue source)
                    throws ValueDoesNotMatchTypeException

Copies the values from source.

Parameters:

source - the source type

Throws:

ValueDoesNotMatchTypeException - in case that values do not match

clone

public ContainerValue clone()

Description copied from class: Value

Clones the this value.

Overrides:

clone in class Value

Returns:

the clone of the value

getElementSize

public int getElementSize()

Returns the number of elements in this container.

Returns:

the number of elements

getElement

public Value getElement(int index)

Returns the specified element.

Parameters:

index - the index of the element to be returned

Returns:

the specified element

Throws:

java.lang.IndexOutOfBoundsException - if index<0 || index>=getElementSize()

indexOf

public int indexOf(Value value)

Returns the (first) index of the specified (nested) value.

Parameters:

value - the value to search for

Returns:

the first index of value or -1 if not found

isSetValue

private boolean isSetValue()

Checks whether this value belongs to a Set or an Sequence.

Returns:

true if this value belongs to a Set, otherwise false.

duplicateValues

private boolean duplicateValues(java.lang.Object[] values)

Checks whether the given array has duplicated values and this value belongs to a set.

Parameters:

values - The values, which shall be assigned to this ContainerValue.

Returns:

true if this value belongs to a set and the value array contains duplicates, otherwise false.

setValue

public void setValue(int index,
                     Value nestedValue)
              throws ValueDoesNotMatchTypeException

Sets the value for an already existent nested value.

Parameters:

index - The index of the element to be configured.

nestedValue - The new value of the nested element.

Throws:

ValueDoesNotMatchTypeException - IF this ContainerValue represents a value of a Set and the new nestedValue is already part of this value.

java.lang.IllegalArgumentException - if some property of the specified element prevents it from being added to this Value

java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= getElementSize())

hashCode

public int hashCode()

Overrides:

hashCode in class Value

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class Value

doAll

private void doAll(java.util.HashSet<Value> set,
                   boolean add)

Adds/removes all elements to/from set.

Parameters:

set - the set to add/remove

add - add (true) or remove (false)

addElement

public void addElement(int pos,
                       Value value)
                throws ValueDoesNotMatchTypeException

Adds a value at the position pos.

Parameters:

pos - the position after which value shall be added

value - the value to be added

Throws:

ValueDoesNotMatchTypeException - in case that the type of value does not match the container type of the containers or that index shall be applied to a set

java.lang.IndexOutOfBoundsException - in case that pos is invalid

checkContainedType

private void checkContainedType(Value value)
                         throws ValueDoesNotMatchTypeException

Checks whether value is type compliant with the getContainedType().

Parameters:

value - the value to check for

Throws:

ValueDoesNotMatchTypeException - in case that the type of value does not match the container type of the containers

addElement

public void addElement(Value value)
                throws ValueDoesNotMatchTypeException

Adds an element to this container. Shall only be called during dynamic execution.

Parameters:

value - the value to be added

Throws:

ValueDoesNotMatchTypeException - in case that the type of value does not match the container type of the containers

removeElement

public void removeElement(Value value)

Removes a value from this container.

Parameters:

value - the value to be removed

removeElement

public void removeElement(int index)

Removes a value from this container.

Parameters:

index - the index position of the value to be removed

Throws:

java.lang.IndexOutOfBoundsException - in case that the index is illegal

equalsPartially

public boolean equalsPartially(Value value)

Description copied from class: Value

Returns whether the provided value is partially equal to this value, i.e., whether the nested elements of value (if they exist) have the same contents as in this value. Other values of this value are not considered. The check is transitive on nested elements. Please consider that this method is not symmetric as opposed to equals. This method is important to cope with default values.

Specified by:

equalsPartially in class Value

Parameters:

value - the value to be checked for partial equality.

Returns:

true if value is partially equal to this, false else

clear

public void clear()

Clears all elements.

iterator

public java.util.Iterator<Value> iterator()

Returns an iterator over all values.

Returns:

the iterator