Package net.ssehub.easy.instantiation.core.model.buildlangModel

Class OtherProjects

java.lang.Object

net.ssehub.easy.instantiation.core.model.buildlangModel.OtherProjects

All Implemented Interfaces:

java.lang.Iterable<IArtifact>, Collection<IArtifact>, IStringValueProvider, IVilGenericType, IVilType, Set<IArtifact>

class OtherProjects
extends java.lang.Object
implements Set<IArtifact>

Realizes the implicit variable OTHERPROJECTS in Script.

Author:

Holger Eichelberger

Nested Class Summary

Nested classes/interfaces inherited from interface net.ssehub.easy.instantiation.core.model.vilTypes.IStringValueProvider

IStringValueProvider.StringComparator

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Set<IArtifact>	data
private TypeDescriptor<?>[]	parameter
private TypeDescriptor<?>	type

Fields inherited from interface net.ssehub.easy.instantiation.core.model.vilTypes.Set

DEFAULT

Constructor Summary

Constructors

Constructor	Description
OtherProjects()	Creates an instance.

Method Summary

Modifier and Type	Method	Description
IArtifact	add(IArtifact artifact)	Adds an element to this set.
boolean	allowSequenceAdjustment()	Returns whether a IStringValueProvider may reorder the sequence of this collection for (test) output.
IArtifact	any(ExpressionEvaluator evaluator)	Returns any element complying with the evaluator.
java.lang.Object	apply(ExpressionEvaluator evaluator)	Processes elements in this set by applying to given expression.
Sequence<IArtifact>	asSequence()	Turns this collection into a sequence.
Set<IArtifact>	asSet()	Turns this collection into a set.
java.lang.Object	avg()	Returns the average of all elements.
void	clear()	Clears this collection.
Set<IArtifact>	cloneCollection()	Clones this collection.
Set<?>	closure(ExpressionEvaluator evaluator)	Calculates a transitive closure over elements provided by this collection and evaluator.
Set<?>	collect(ExpressionEvaluator evaluator)	Collects the application of evaluator to each individual element and flattens nested structures.
Set<?>	collectNested(ExpressionEvaluator evaluator)	Collects the application of evaluator to each individual element and keeps nested structures.
int	count(IArtifact element)	Returns the number of elements in this collection which are equal to element.
Set<IArtifact>	difference(Set<IArtifact> set)	Calculates the difference between this and the given set.
boolean	excludes(IArtifact element)	Returns whether this collection does not contain a certain element.
boolean	excludesAll(Collection<?> elements)	Returns whether this collection contains no elements from elements.
Set<IArtifact>	excluding(Collection<IArtifact> set)	Exclude the elements in set.
java.lang.Boolean	exists(ExpressionEvaluator evaluator)	Returns whether there exists on element in the collection for which the evaluator returns true.
Set<?>	flatten()	Flattens this collection if needed, i.e., flatten sub-collections.
java.lang.Boolean	forAll(ExpressionEvaluator evaluator)	Returns whether all elements in the collection for which the evaluator returns true.
int	getGenericParameterCount()	Returns the number of generic parameters of T.
TypeDescriptor<?>	getGenericParameterType(int index)	Returns the type of the specified generic parameter of T.
java.lang.String	getStringValue(IStringValueProvider.StringComparator comparator)	Returns the string value of this object.
TypeDescriptor<?>	getType()	Returns the actual type including generics.
boolean	includes(IArtifact element)	Returns whether this collection contains a certain element.
boolean	includesAll(Collection<?> elements)	Returns whether this collection contains all elements in elements.
Set<IArtifact>	including(Collection<IArtifact> set)	Include the elements in set.
Set<IArtifact>	intersection(Set<IArtifact> set)	Returns the intersection of this set with set.
boolean	isAcyclic(ExpressionEvaluator evaluator)	Returns whether the transitive closure over elements provided by this collection and evaluator does not contain a cycle.
boolean	isEmpty()	Returns whether the collection is empty.
boolean	isEquals(Collection<?> elements)	Returns whether this collection is equal to elements.
boolean	isNotEmpty()	Returns whether the collection is not empty (inverse of Collection.isEmpty().
java.lang.Boolean	isUnique(ExpressionEvaluator evaluator)	Returns whether the evaluator returns a different result for all elements in the collection.
java.util.Iterator<IArtifact>	iterator()	Returns an iterator on the individual elements of this collection.
IArtifact	max()	Returns the maximum of all elements.
IArtifact	min()	Returns the minimum of all elements.
IArtifact	one(ExpressionEvaluator evaluator)	Returns the element complying with the evaluator if there is exactly one.
IArtifact	product()	Returns the product of all elements.
IArtifact	projectSingle()	In case that the sequence has exactly one element, this will be returned.
Set<IArtifact>	reject(ExpressionEvaluator evaluator)	Rejects elements in this collection according to the given expression.
boolean	remove(IArtifact element)	Removes the given element from this sequence.
Set<IArtifact>	select(ExpressionEvaluator evaluator)	Selects elements in this collection according to the given expression.
Set<IArtifact>	selectByKind(TypeDescriptor<?> type)	Does type selection of elements (including subtypes).
Set<IArtifact>	selectByType(TypeDescriptor<?> type)	Does type selection of elements (only the same type).
int	size()	Returns the number of elements in the underlying collection.
Collection<IArtifact>	sortedBy(ExpressionEvaluator evaluator)	Sorts the elements in this collection according to the given expression in ascending order.
IArtifact	sum()	Returns the sum of all elements.
Set<IArtifact>	symmetricDifference(Set<IArtifact> set)	Calculates the symmetric difference between this and the given set.
java.util.Set<IArtifact>	toMappedSet()	Converts back to a set for utilizing this with external classes.
Sequence<IArtifact>	toSequence()	Turns this set into a sequence.
Set<IArtifact>	typeReject(TypeDescriptor<?> type)	Does type selection of elements not having the same type (including subtypes).
Set<IArtifact>	union(Set<IArtifact> set)	Compute the union of this set and set (without duplicates).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

data

private java.util.Set<IArtifact> data

parameter

private TypeDescriptor<?>[] parameter

type

private TypeDescriptor<?> type

Constructor Detail

OtherProjects

OtherProjects()

Creates an instance.

Method Detail

getGenericParameterCount

public int getGenericParameterCount()

Description copied from interface: Collection

Returns the number of generic parameters of T.

Specified by:

getGenericParameterCount in interface Collection<IArtifact>

Returns:

the number of generic parameter

getGenericParameterType

public TypeDescriptor<?> getGenericParameterType(int index)

Description copied from interface: Collection

Returns the type of the specified generic parameter of T.

Specified by:

getGenericParameterType in interface Collection<IArtifact>

Parameters:

index - the 0-based index of the generic parameter

Returns:

the actual type of the generic parameter

size

public int size()

Description copied from interface: Collection

Returns the number of elements in the underlying collection.

Specified by:

size in interface Collection<IArtifact>

Returns:

the number of elements

allowSequenceAdjustment

public boolean allowSequenceAdjustment()

Description copied from interface: Collection

Returns whether a IStringValueProvider may reorder the sequence of this collection for (test) output.

Specified by:

allowSequenceAdjustment in interface Collection<IArtifact>

Returns:

true if a value provider may reorder the sequence, false else

isEmpty

public boolean isEmpty()

Description copied from interface: Collection

Returns whether the collection is empty.

Specified by:

isEmpty in interface Collection<IArtifact>

Returns:

true if it is empty, false else

isNotEmpty

public boolean isNotEmpty()

Description copied from interface: Collection

Returns whether the collection is not empty (inverse of Collection.isEmpty().

Specified by:

isNotEmpty in interface Collection<IArtifact>

Returns:

false if it is empty, true else

includes

public boolean includes(IArtifact element)

Description copied from interface: Collection

Returns whether this collection contains a certain element.

Specified by:

includes in interface Collection<IArtifact>

Parameters:

element - the element to look for

Returns:

true if this collection contains element, false else

excludes

public boolean excludes(IArtifact element)

Description copied from interface: Collection

Returns whether this collection does not contain a certain element.

Specified by:

excludes in interface Collection<IArtifact>

Parameters:

element - the element to look for

Returns:

true if this collection does not contain element, true else

count

public int count(IArtifact element)

Description copied from interface: Collection

Returns the number of elements in this collection which are equal to element.

Specified by:

count in interface Collection<IArtifact>

Parameters:

element - the element to look for

Returns:

the number of equal elements in this collection

iterator

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

Description copied from interface: Collection

Returns an iterator on the individual elements of this collection.

Specified by:

iterator in interface Collection<IArtifact>

Specified by:

iterator in interface java.lang.Iterable<IArtifact>

Returns:

the iterator

isEquals

public boolean isEquals(Collection<?> elements)

Description copied from interface: Collection

Returns whether this collection is equal to elements. Please note that the actual semantics, i.e., whether the elements must also be in the same sequence, depends on the actual semantics of the collection.

Specified by:

isEquals in interface Collection<IArtifact>

Parameters:

elements - the collection to be tested

Returns:

true if both collections are considered to be equal, false else

getStringValue

public java.lang.String getStringValue(IStringValueProvider.StringComparator comparator)

Description copied from interface: IStringValueProvider

Returns the string value of this object.

Specified by:

getStringValue in interface IStringValueProvider

Parameters:

comparator - if the sequence of elements, e.g., in case of collections, shall be ordered according to the comparator, null if the original sequence shall be returned

Returns:

the string value

selectByType

public Set<IArtifact> selectByType(TypeDescriptor<?> type)

Description copied from interface: Collection

Does type selection of elements (only the same type).

Specified by:

selectByType in interface Collection<IArtifact>

Specified by:

selectByType in interface Set<IArtifact>

Parameters:

type - the target type

Returns:

the selected elements (the type will be adjusted to the actual type for type)

selectByKind

public Set<IArtifact> selectByKind(TypeDescriptor<?> type)

Description copied from interface: Collection

Does type selection of elements (including subtypes).

Specified by:

selectByKind in interface Collection<IArtifact>

Specified by:

selectByKind in interface Set<IArtifact>

Parameters:

type - the target type

Returns:

the selected elements (the type will be adjusted to the actual type for type)

typeReject

public Set<IArtifact> typeReject(TypeDescriptor<?> type)

Description copied from interface: Collection

Does type selection of elements not having the same type (including subtypes).

Specified by:

typeReject in interface Collection<IArtifact>

Specified by:

typeReject in interface Set<IArtifact>

Parameters:

type - the target type

Returns:

the selected elements (the type will be adjusted to the actual type for type)

excluding

public Set<IArtifact> excluding(Collection<IArtifact> set)

Description copied from interface: Set

Exclude the elements in set.

Specified by:

excluding in interface Set<IArtifact>

Parameters:

set - the elements to be excluded

Returns:

this set without the elements in set

including

public Set<IArtifact> including(Collection<IArtifact> set)

Description copied from interface: Set

Include the elements in set. Duplicates will not be included.

Specified by:

including in interface Set<IArtifact>

Parameters:

set - the elements to be excluded

Returns:

this set without the elements in set

flatten

public Set<?> flatten()
               throws VilException

Description copied from interface: Collection

Flattens this collection if needed, i.e., flatten sub-collections.

Specified by:

flatten in interface Collection<IArtifact>

Specified by:

flatten in interface Set<IArtifact>

Returns:

the flattened collection

Throws:

VilException - in case of type incompatibilities

select

public Set<IArtifact> select(ExpressionEvaluator evaluator)
                      throws VilException

Description copied from interface: Collection

Selects elements in this collection according to the given expression.

Specified by:

select in interface Collection<IArtifact>

Specified by:

select in interface Set<IArtifact>

Parameters:

evaluator - the evaluator (results must evaluate to Boolean)

Returns:

the selected elements

Throws:

VilException - in case that evaluation fails

reject

public Set<IArtifact> reject(ExpressionEvaluator evaluator)
                      throws VilException

Description copied from interface: Collection

Rejects elements in this collection according to the given expression.

Specified by:

reject in interface Collection<IArtifact>

Specified by:

reject in interface Set<IArtifact>

Parameters:

evaluator - the evaluator (results must evaluate to Boolean)

Returns:

the rejected elements

Throws:

VilException - in case that evaluation fails

collect

public Set<?> collect(ExpressionEvaluator evaluator)
               throws VilException

Description copied from interface: Collection

Collects the application of evaluator to each individual element and flattens nested structures.

Specified by:

collect in interface Collection<IArtifact>

Specified by:

collect in interface Set<IArtifact>

Parameters:

evaluator - the evaluator (results must evaluate to Boolean)

Returns:

the application results

Throws:

VilException - in case that evaluation fails

collectNested

public Set<?> collectNested(ExpressionEvaluator evaluator)
                     throws VilException

Description copied from interface: Collection

Collects the application of evaluator to each individual element and keeps nested structures.

Specified by:

collectNested in interface Collection<IArtifact>

Specified by:

collectNested in interface Set<IArtifact>

Parameters:

evaluator - the evaluator (results must evaluate to Boolean)

Returns:

the application results

Throws:

VilException - in case that evaluation fails

closure

public Set<?> closure(ExpressionEvaluator evaluator)
               throws VilException

Description copied from interface: Collection

Calculates a transitive closure over elements provided by this collection and evaluator.

Specified by:

closure in interface Collection<IArtifact>

Specified by:

closure in interface Set<IArtifact>

Parameters:

evaluator - the evaluator providing the links/collections to follow

Returns:

the closure

Throws:

VilException - in case that evaluation fails

isAcyclic

public boolean isAcyclic(ExpressionEvaluator evaluator)
                  throws VilException

Description copied from interface: Collection

Returns whether the transitive closure over elements provided by this collection and evaluator does not contain a cycle.

Specified by:

isAcyclic in interface Collection<IArtifact>

Parameters:

evaluator - the evaluator providing the links/collections to follow

Returns:

true for cycle, false else

Throws:

VilException - in case that evaluation fails

apply

public java.lang.Object apply(ExpressionEvaluator evaluator)
                       throws VilException

Description copied from interface: Collection

Processes elements in this set by applying to given expression.

Specified by:

apply in interface Collection<IArtifact>

Parameters:

evaluator - the evaluator holding the iterator / expression to apply

Returns:

the aggregated value, null in case of no aggregation

Throws:

VilException - in case that selection fails

toSequence

public Sequence<IArtifact> toSequence()

Description copied from interface: Set

Turns this set into a sequence.

Specified by:

toSequence in interface Set<IArtifact>

Returns:

the set containing the elements of this set

asSequence

public Sequence<IArtifact> asSequence()

Description copied from interface: Collection

Turns this collection into a sequence.

Specified by:

asSequence in interface Collection<IArtifact>

Returns:

the set containing the elements of this collection

asSet

public Set<IArtifact> asSet()

Description copied from interface: Collection

Turns this collection into a set.

Specified by:

asSet in interface Collection<IArtifact>

Returns:

the set containing the elements of this collection (excluding duplicates)

add

public IArtifact add(IArtifact artifact)

Description copied from interface: Set

Adds an element to this set.

Specified by:

add in interface Set<IArtifact>

Parameters:

artifact - the element to be added

Returns:

element

projectSingle

public IArtifact projectSingle()

Description copied from interface: Set

In case that the sequence has exactly one element, this will be returned.

Specified by:

projectSingle in interface Set<IArtifact>

Returns:

the only element or null

remove

public boolean remove(IArtifact element)

Description copied from interface: Set

Removes the given element from this sequence.

Specified by:

remove in interface Set<IArtifact>

Parameters:

element - the element to be removed

Returns:

true of the element was removed, false else

toMappedSet

public java.util.Set<IArtifact> toMappedSet()

Description copied from interface: Set

Converts back to a set for utilizing this with external classes.

Specified by:

toMappedSet in interface Set<IArtifact>

Returns:

the internal map

getType

public TypeDescriptor<?> getType()

Description copied from interface: IVilGenericType

Returns the actual type including generics. "Overrides" PseudoAny.getType(Object).

Specified by:

getType in interface IVilGenericType

Returns:

the actual type

union

public Set<IArtifact> union(Set<IArtifact> set)

Description copied from interface: Set

Compute the union of this set and set (without duplicates).

Specified by:

union in interface Set<IArtifact>

Parameters:

set - the elements to be unified with this set

Returns:

the union of this set and set

intersection

public Set<IArtifact> intersection(Set<IArtifact> set)

Description copied from interface: Set

Returns the intersection of this set with set.

Specified by:

intersection in interface Set<IArtifact>

Parameters:

set - the elements to be unified with this set

Returns:

the intersection of this set and set

clear

public void clear()

Description copied from interface: Collection

Clears this collection.

Specified by:

clear in interface Collection<IArtifact>

sum

public IArtifact sum()

Description copied from interface: Collection

Returns the sum of all elements.

Specified by:

sum in interface Collection<IArtifact>

Returns:

the sum of all elements or null if the elements do not define addition

avg

public java.lang.Object avg()

Description copied from interface: Collection

Returns the average of all elements.

Specified by:

avg in interface Collection<IArtifact>

Returns:

the average of all elements or null if the elements do not define addition or division

product

public IArtifact product()

Description copied from interface: Collection

Returns the product of all elements.

Specified by:

product in interface Collection<IArtifact>

Returns:

the product of all elements or null if the elements do not define multiplication

min

public IArtifact min()

Description copied from interface: Collection

Returns the minimum of all elements.

Specified by:

min in interface Collection<IArtifact>

Returns:

the minimum of all elements or null if the elements do not define the minimum operation

max

public IArtifact max()

Description copied from interface: Collection

Returns the maximum of all elements.

Specified by:

max in interface Collection<IArtifact>

Returns:

the maximum of all elements or null if the elements do not define the maximum operation

includesAll

public boolean includesAll(Collection<?> elements)

Description copied from interface: Collection

Returns whether this collection contains all elements in elements.

Specified by:

includesAll in interface Collection<IArtifact>

Parameters:

elements - the elements to look for

Returns:

true if this collection contains all elements, false else

excludesAll

public boolean excludesAll(Collection<?> elements)

Description copied from interface: Collection

Returns whether this collection contains no elements from elements.

Specified by:

excludesAll in interface Collection<IArtifact>

Parameters:

elements - the elements to look for

Returns:

true if this collection contains none from elements, false else

any

public IArtifact any(ExpressionEvaluator evaluator)
              throws VilException

Description copied from interface: Collection

Returns any element complying with the evaluator.

Specified by:

any in interface Collection<IArtifact>

Parameters:

evaluator - the evaluator (results must evaluate to Boolean)

Returns:

one element complying with evaluator

Throws:

VilException - in case that application fails

one

public IArtifact one(ExpressionEvaluator evaluator)
              throws VilException

Description copied from interface: Collection

Returns the element complying with the evaluator if there is exactly one.

Specified by:

one in interface Collection<IArtifact>

Parameters:

evaluator - the evaluator (results must evaluate to Boolean)

Returns:

the element complying with evaluator

Throws:

VilException - in case that evaluation fails

exists

public java.lang.Boolean exists(ExpressionEvaluator evaluator)
                         throws VilException

Description copied from interface: Collection

Returns whether there exists on element in the collection for which the evaluator returns true.

Specified by:

exists in interface Collection<IArtifact>

Parameters:

evaluator - the evaluator

Returns:

true for the exists one, false else

Throws:

VilException - in case that evaluation fails

forAll

public java.lang.Boolean forAll(ExpressionEvaluator evaluator)
                         throws VilException

Description copied from interface: Collection

Returns whether all elements in the collection for which the evaluator returns true.

Specified by:

forAll in interface Collection<IArtifact>

Parameters:

evaluator - the evaluator

Returns:

true for the exists one, false else

Throws:

VilException - in case that evaluation fails

isUnique

public java.lang.Boolean isUnique(ExpressionEvaluator evaluator)
                           throws VilException

Description copied from interface: Collection

Returns whether the evaluator returns a different result for all elements in the collection.

Specified by:

isUnique in interface Collection<IArtifact>

Parameters:

evaluator - the evaluator

Returns:

true if all results are different, false else

Throws:

VilException - in case that evaluation fails

sortedBy

public Collection<IArtifact> sortedBy(ExpressionEvaluator evaluator)
                               throws VilException

Description copied from interface: Collection

Sorts the elements in this collection according to the given expression in ascending order.

Specified by:

sortedBy in interface Collection<IArtifact>

Parameters:

evaluator - the evaluator

Returns:

the selected elements

Throws:

VilException - in case that selection fails

difference

public Set<IArtifact> difference(Set<IArtifact> set)

Description copied from interface: Set

Calculates the difference between this and the given set.

Specified by:

difference in interface Set<IArtifact>

Parameters:

set - the set to calculate the difference for

Returns:

the set difference

symmetricDifference

public Set<IArtifact> symmetricDifference(Set<IArtifact> set)

Description copied from interface: Set

Calculates the symmetric difference between this and the given set.

Specified by:

symmetricDifference in interface Set<IArtifact>

Parameters:

set - the set to calculate the difference for

Returns:

the symmetric set difference

cloneCollection

public Set<IArtifact> cloneCollection()

Description copied from interface: Collection

Clones this collection. (QVT)

Specified by:

cloneCollection in interface Collection<IArtifact>

Specified by:

cloneCollection in interface Set<IArtifact>

Returns:

a clone of this collection