net.sourceforge.plantumldependency.cli.generic.type

Interface ImportDependenciesCollection

All Superinterfaces:

Cloneable, net.sourceforge.plantumldependency.common.clone.DeepCloneable<ImportDependenciesCollection>, Serializable

All Known Implementing Classes:

ImportDependenciesCollectionImpl

public interface ImportDependenciesCollection
extends Serializable, net.sourceforge.plantumldependency.common.clone.DeepCloneable<ImportDependenciesCollection>

The interface which describes a collection of import dependencies needed by a GenericDependency.

Since:

1.1.1

Version:

1.3.0

Author:

Benjamin Croizet (

Method Summary

Methods

Modifier and Type	Method and Description
void	addImportDependencies(ImportType importType, GenericDependency importDependency) Add an import dependency to the collection, with its type.
void	addImportDependenciesSet(ImportType importType, Set<GenericDependency> importDependenciesSet) Add a Set of several import dependencies to the collection, with their type.
GenericDependency	findDependency(String dependencyName) Finds the dependency following its name in the collection. be careful, this method doesn't take care of the package name.
GenericDependency	findDependency(String dependencyName, String dependencyPackageName) Finds the dependency following its name and its package name in the collection.
Set<GenericDependency>	getAllImportDependencies() Gets the Set of all GenericDependency which are needed by the current dependency type to work.
Set<GenericDependency>	getImportDependenciesWithType(ImportType importType) Gets the Set of GenericDependency which are needed by the current dependency type to work and have the following type.
Set<GenericDependency>	getImportDependenciesWithTypes(Set<ImportType> importTypesSet) Gets the Set of GenericDependency which are needed by the current dependency type to work and have one of the following type contained in the Set.

Methods inherited from interface net.sourceforge.plantumldependency.common.clone.DeepCloneable

deepClone

Method Detail

addImportDependencies

void addImportDependencies(ImportType importType,
                         GenericDependency importDependency)

Add an import dependency to the collection, with its type.

Parameters:

importType - the import dependency ImportType instance, mustn't be null.

importDependency - the GenericDependency instance, mustn't be null.

Since:

1.1.1

addImportDependenciesSet

void addImportDependenciesSet(ImportType importType,
                            Set<GenericDependency> importDependenciesSet)

Add a Set of several import dependencies to the collection, with their type.

Parameters:

importType - the import type ImportType instance, mustn't be null.

importDependenciesSet - the Set containing import GenericDependency instances, mustn't be null.

Since:

1.1.1

findDependency

GenericDependency findDependency(String dependencyName)

Finds the dependency following its name in the collection. be careful, this method doesn't take care of the package name.

Parameters:

dependencyName - the dependency name to look for, mustn't be null.

Returns:

the GenericDependency instance associated to the passed name if found in the import import collection, null otherwise.

Since:

1.1.1

findDependency

GenericDependency findDependency(String dependencyName,
                               String dependencyPackageName)

Finds the dependency following its name and its package name in the collection.

Parameters:

dependencyName - the dependency name to look for, mustn't be null.

dependencyPackageName - the dependency package name to look for, mustn't be null.

Returns:

the GenericDependency instance associated to the passed name and package name if found in the import collection, null otherwise.

Since:

1.1.1

getAllImportDependencies

Set<GenericDependency> getAllImportDependencies()

Gets the Set of all GenericDependency which are needed by the current dependency type to work. If no dependencies are needed, it returns an empty Set.

For instance, in java it is represented by the import keyword.

Returns:

the Set of all GenericDependency which are needed by the current dependency type to work.

Since:

1.1.1

getImportDependenciesWithType

Set<GenericDependency> getImportDependenciesWithType(ImportType importType)

Gets the Set of GenericDependency which are needed by the current dependency type to work and have the following type. If no dependencies are needed with this type, it returns an empty Set.

For instance, in java it is represented by the import keyword.

Parameters:

importType - the import type to look for, mustn't be null.

Returns:

the Set of GenericDependency which are needed by the current dependency type to work and have the following types.

Since:

1.1.1

getImportDependenciesWithTypes

Set<GenericDependency> getImportDependenciesWithTypes(Set<ImportType> importTypesSet)

Gets the Set of GenericDependency which are needed by the current dependency type to work and have one of the following type contained in the Set. If no dependencies are needed with these types, it returns an empty Set.

For instance, in java it is represented by the import keyword.

Parameters:

importTypesSet - the Set of all import types to look for, mustn't be null.

Returns:

the Set of all GenericDependency which are needed by the current dependency type to work.

Since:

1.1.1