net.sourceforge.plantumldependency.cli.generic.type

Interface DependencyType

All Superinterfaces:

Cloneable, Comparable<DependencyType>, net.sourceforge.plantumldependency.common.clone.DeepCloneable<DependencyType>, Displayable, Serializable

All Known Implementing Classes:

AnnotationDependencyTypeImpl, ClassAbstractDependencyTypeImpl, ClassDependencyTypeImpl, DependencyTypeImpl, EnumDependencyTypeImpl, InterfaceDependencyTypeImpl, NativeDependencyTypeImpl, StubDependencyTypeImpl

public interface DependencyType
extends Comparable<DependencyType>, Serializable, net.sourceforge.plantumldependency.common.clone.DeepCloneable<DependencyType>, Displayable

The interface which describes a generic dependency type, no matter the programming language is. A dependency type might be a class, an interface, an enumeration or an annotation.

Since:

1.0.0

Version:

1.4.0

Author:

Benjamin Croizet (

Method Summary

Methods

Modifier and Type	Method and Description
Set<GenericDependency>	getAnnotationsDependencies() Gets the Set of all annotations as GenericDependency which are used by the current dependency type.
String	getFullName() Gets the dependency full name, usually the package and the dependency name.
ImportDependenciesCollection	getImportDependenciesCollection() Gets the ImportDependenciesCollection containing all GenericDependency which are needed by the current dependency type to work.
String	getName() Gets the dependency name, usually the class name.
String	getPackageName() Gets the dependency package name.
Set<GenericDependency>	getParentExtensionsDependencies() Gets the Set of all parent extensions as GenericDependency which are used by the current dependency type, i.e. extended.
Set<GenericDependency>	getParentImplementationsDependencies() Gets the Set of all parent interfaces as GenericDependency which are used by the current dependency type, i.e. implemented.
PlantUMLClassesDiagramElement	getPlantUMLClassesDiagramElement() Gets the PlantUML classes diagram element describing the current dependency type in the plantUML language.
Set<PlantUMLClassesDiagramRelation>	getPlantUMLClassesDiagramRelations() Gets the whole PlantUML classes diagram relations.
Set<PlantUMLClassesDiagramRelation>	getPlantUMLClassesDiagramRelations(Set<DisplayType> displayTypesOptions, Pattern displayPackageNamePattern, Pattern displayNamePattern) Gets the PlantUML classes diagram relations, following the imports, the dependency type parents and the passed display options (type, name and package name).
void	setFullName(String dependencyPackageName, String dependencyName) Sets the dependency full name, i.e. the package name and the class name.

Methods inherited from interface java.lang.Comparable

compareTo

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

deepClone

Methods inherited from interface net.sourceforge.plantumldependency.cli.generic.type.Displayable

isDisplayable

Method Detail

getAnnotationsDependencies

Set<GenericDependency> getAnnotationsDependencies()

Gets the Set of all annotations as GenericDependency which are used by the current dependency type. If no dependencies annotations are used, it returns an empty Set.

Returns:

the Set of all annotations as GenericDependency which are used by the current dependency type.

Since:

1.2.0

getFullName

String getFullName()

Gets the dependency full name, usually the package and the dependency name.

For instance, in java it can be :
java.lang.String
java.io.Serializable
sun.font.Decoration

Returns:

the dependency full name.

Since:

1.0.0

getImportDependenciesCollection

ImportDependenciesCollection getImportDependenciesCollection()

Gets the ImportDependenciesCollection containing all GenericDependency which are needed by the current dependency type to work.

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

Returns:

the ImportDependenciesCollection instance containing all GenericDependency which are needed by the current dependency type to work.

Since:

1.0.0

getName

String getName()

Gets the dependency name, usually the class name.

For instance, in java it can be :
String
Serializable
Decoration

Returns:

the dependency name.

Since:

1.0.0

See Also:

setFullName(String, String)

getPackageName

String getPackageName()

Gets the dependency package name.

For instance, in java it can be :
java.lang
java.io
sun.font

Returns:

the dependency package name.

Since:

1.0.0

See Also:

setFullName(String, String)

getParentExtensionsDependencies

Set<GenericDependency> getParentExtensionsDependencies()

Gets the Set of all parent extensions as GenericDependency which are used by the current dependency type, i.e. extended. If no dependencies are extended, it returns an empty Set.

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

Returns:

the Set of all parent extensions as GenericDependency which are used by the current dependency type.

Since:

1.2.0

getParentImplementationsDependencies

Set<GenericDependency> getParentImplementationsDependencies()

Gets the Set of all parent interfaces as GenericDependency which are used by the current dependency type, i.e. implemented. If no dependencies interfaces are implemented, it returns an empty Set.

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

Returns:

the Set of all parent interfaces as GenericDependency which are used by the current dependency type.

Since:

1.0.0

getPlantUMLClassesDiagramElement

PlantUMLClassesDiagramElement getPlantUMLClassesDiagramElement()

Gets the PlantUML classes diagram element describing the current dependency type in the plantUML language. See the PlantUML Language Reference Guide.pdf or http://plantuml.sourceforge.net/classes.html page.

Returns:

the plantUML classes diagram element as a PlantUMLClassesDiagramElement instance describing the current dependency type.

Since:

1.1.1

getPlantUMLClassesDiagramRelations

Set<PlantUMLClassesDiagramRelation> getPlantUMLClassesDiagramRelations()

Gets the whole PlantUML classes diagram relations.

Returns:

the set of all PlantUML classes diagram relations as a Set of PlantUMLClassesDiagramRelation instances describing relations to imports and the dependency type parents.

Since:

1.2.0

getPlantUMLClassesDiagramRelations

Set<PlantUMLClassesDiagramRelation> getPlantUMLClassesDiagramRelations(Set<DisplayType> displayTypesOptions,
                                                                     Pattern displayPackageNamePattern,
                                                                     Pattern displayNamePattern)

Gets the PlantUML classes diagram relations, following the imports, the dependency type parents and the passed display options (type, name and package name).

Parameters:

displayTypesOptions - the Set of display types options which filter relations type, mustn't be null, if empty, this method always returns false, mustn't be null.

displayPackageNamePattern - the Pattern which filter relations package name, if empty, this method always returns false, mustn't be null.

displayNamePattern - the Pattern which filter relations name, if empty, this method always returns false, mustn't be null.

Returns:

the set of all PlantUML classes diagram relations as a Set of PlantUMLClassesDiagramRelation instances describing relations to imports and the dependency type parents.

Since:

1.1.1

setFullName

void setFullName(String dependencyPackageName,
               String dependencyName)

Sets the dependency full name, i.e. the package name and the class name.

For instance, in java it can be :
String
Serializable
Decoration

Parameters:

dependencyPackageName - the new package name to set, may be null.

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

Since:

1.2.0

See Also:

getName(), getPackageName()