edu.uci.isr.xarch.variants
Interface IVariantConnectorType

All Superinterfaces:

IConnectorType, IXArchElement

All Known Subinterfaces:

IVariantConnectorTypeImpl, IVariantConnectorTypeImplVers, IVariantConnectorTypeImplVersSpec

All Known Implementing Classes:

VariantConnectorTypeImpl, VariantConnectorTypeImplImpl, VariantConnectorTypeImplVersImpl, VariantConnectorTypeImplVersSpecImpl

public interface IVariantConnectorType

extends IConnectorType, IXArchElement

Interface for accessing objects of the VariantConnectorType xsi:type in the variants namespace. Extends and inherits the properties of the ConnectorType xsi:type.

Author:

xArch apigen

Field Summary

static XArchTypeMetadata

TYPE_METADATA

Fields inherited from interface edu.uci.isr.xarch.IXArchElement

DEPTH_INFINITY, DEPTH_ONE, DEPTH_ZERO

Method Summary

void	addVariant(IVariant newVariant) Add a variant to this VariantConnectorType.
void	addVariants(Collection variants) Add a collection of variants to this VariantConnectorType.
void	clearVariants() Remove all variants from this VariantConnectorType.
Collection	getAllVariants() Get all the variants from this VariantConnectorType.
boolean	hasAllVariants(Collection variantsToCheck) Determine if this VariantConnectorType contains each element in the given set of variants.
boolean	hasVariant(IVariant variantToCheck) Determine if this VariantConnectorType contains a given variant.
Collection	hasVariants(Collection variantsToCheck) Determine if this VariantConnectorType contains the given set of variants.
boolean	isEquivalent(IVariantConnectorType VariantConnectorTypeToCheck) Determine if another VariantConnectorType is equivalent to this one, ignoring ID's.
void	removeVariant(IVariant variantToRemove) Remove the given variant from this VariantConnectorType.
void	removeVariants(Collection variants) Remove all the given variants from this VariantConnectorType.

Methods inherited from interface edu.uci.isr.xarch.types.IConnectorType

addSignature, addSignatures, clearDescription, clearId, clearSignatures, clearSubArchitecture, getAllSignatures, getDescription, getId, getSignature, getSignatures, getSubArchitecture, hasAllSignatures, hasDescription, hasId, hasSignature, hasSignatures, hasSubArchitecture, isEqual, isEquivalent, removeSignature, removeSignatures, setDescription, setId, setSubArchitecture

Methods inherited from interface edu.uci.isr.xarch.IXArchElement

cloneElement, getInstanceMetadata, getTypeMetadata, getXArch, setXArch

Field Detail

TYPE_METADATA

public static final XArchTypeMetadata TYPE_METADATA

Method Detail

addVariant

public void addVariant(IVariant newVariant)

Add a variant to this VariantConnectorType.

Parameters:

newVariant - variant to add.

addVariants

public void addVariants(Collection variants)

Add a collection of variants to this VariantConnectorType.

Parameters:

variants - variants to add.

clearVariants

public void clearVariants()

Remove all variants from this VariantConnectorType.

removeVariant

public void removeVariant(IVariant variantToRemove)

Remove the given variant from this VariantConnectorType. Matching is done by the isEquivalent(...) function.

Parameters:

variantToRemove - variant to remove.

removeVariants

public void removeVariants(Collection variants)

Remove all the given variants from this VariantConnectorType. Matching is done by the isEquivalent(...) function.

Parameters:

variants - variant to remove.

getAllVariants

public Collection getAllVariants()

Get all the variants from this VariantConnectorType.

Returns:

all variants in this VariantConnectorType.

hasVariant

public boolean hasVariant(IVariant variantToCheck)

Determine if this VariantConnectorType contains a given variant.

Returns:

true if this VariantConnectorType contains the given variantToCheck, false otherwise.

hasVariants

public Collection hasVariants(Collection variantsToCheck)

Determine if this VariantConnectorType contains the given set of variants.

Parameters:

variantsToCheck - variants to check for.

Returns:

Collection of java.lang.Boolean. If the i^th element in variants was found, then the i^th element of the collection will be set to true, otherwise it will be set to false. Matching is done with the isEquivalent(...) method.

hasAllVariants

public boolean hasAllVariants(Collection variantsToCheck)

Determine if this VariantConnectorType contains each element in the given set of variants.

Parameters:

variantsToCheck - variants to check for.

Returns:

true if every element in variants is found in this VariantConnectorType, false otherwise.

isEquivalent

public boolean isEquivalent(IVariantConnectorType VariantConnectorTypeToCheck)

Determine if another VariantConnectorType is equivalent to this one, ignoring ID's.

Parameters:

VariantConnectorTypeToCheck - VariantConnectorType to compare to this one.

Returns:

true if all the child elements of this VariantConnectorType are equivalent, false otherwise.