net.sourceforge.plantumldependency.cli.generic.type.impl

Class DependencyTypeImpl

java.lang.Object

net.sourceforge.plantumldependency.cli.generic.type.impl.DependencyTypeImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

AnnotationDependencyTypeImpl, ClassDependencyTypeImpl, EnumDependencyTypeImpl, InterfaceDependencyTypeImpl, NativeDependencyTypeImpl, StubDependencyTypeImpl

public abstract class DependencyTypeImpl
extends Object
implements DependencyType

The default implementation of the DependencyType interface.

Since:

1.0.0

Version:

1.4.0

Author:

Benjamin Croizet (See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DependencyTypeImpl(String dependencyName, String dependencyPackageName) Default constructor.
protected	DependencyTypeImpl(String dependencyName, String dependencyPackageName, ImportDependenciesCollection importDependencies, Set<GenericDependency> parentExtensionsDependenciesSet, Set<GenericDependency> parentImplementationsDependenciesSet, Set<GenericDependency> annotationsDependenciesSet) Full constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(DependencyType d)
DependencyType	deepClone()
boolean	equals(Object obj)
static String	generateDependencyFullName(String dependencyPackageName, String dependencyName) Generates the full dependency name following its package and its simple name.
protected abstract PlantUMLClassesDiagramElement	generatePlantUMLClassesDiagramElement() Generates the plantUML classes diagram element.
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).
int	hashCode()
void	setFullName(String dependencyPackageName, String dependencyName) Sets the dependency full name, i.e. the package name and the class name.
String	toString()

Methods inherited from class java.lang.Object

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

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

isDisplayable

Constructor Detail

DependencyTypeImpl

protected DependencyTypeImpl(String dependencyName,
                  String dependencyPackageName)

Default constructor.

Parameters:

dependencyName - the dependency type name, such as "String", mustn't be null.

dependencyPackageName - the dependency type package name, such as "java.lang", mustn't be null.

Since:

1.0.0

DependencyTypeImpl

protected DependencyTypeImpl(String dependencyName,
                  String dependencyPackageName,
                  ImportDependenciesCollection importDependencies,
                  Set<GenericDependency> parentExtensionsDependenciesSet,
                  Set<GenericDependency> parentImplementationsDependenciesSet,
                  Set<GenericDependency> annotationsDependenciesSet)

Full constructor.

Parameters:

dependencyName - the dependency type name, such as "String", mustn't be null.

dependencyPackageName - the dependency type package name, such as "java.lang", mustn't be null.

importDependencies - the ImportDependenciesCollection containing all import dependencies which are needed by the current dependency type to work, mustn't be null.

parentExtensionsDependenciesSet - the Set of all extensions as GenericDependency which are used by the current dependency type, mustn't be null.

parentImplementationsDependenciesSet - the Set of all implementations as GenericDependency which are used by the current dependency type, mustn't be null.

annotationsDependenciesSet - the Set of all annotations as GenericDependency which are used by the current dependency type, mustn't be null.

Since:

1.0.0

Method Detail

generateDependencyFullName

public static String generateDependencyFullName(String dependencyPackageName,
                                String dependencyName)

Generates the full dependency name following its package and its simple name.

Parameters:

dependencyPackageName - the dependency type package name, such as "java.lang", mustn't be null but can be empty.

dependencyName - the dependency type name, such as "String", mustn't be null nor empty.

Returns:

the full dependency name.

Since:

1.0.0

compareTo

public int compareTo(DependencyType d)

Specified by:

compareTo in interface Comparable<DependencyType>

Since:

1.0.0

deepClone

public DependencyType deepClone()

Specified by:

deepClone in interface net.sourceforge.plantumldependency.common.clone.DeepCloneable<DependencyType>

Since:

1.0.0

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Since:

1.0.0

generatePlantUMLClassesDiagramElement

protected abstract PlantUMLClassesDiagramElement generatePlantUMLClassesDiagramElement()

Generates the plantUML classes diagram element.

Returns:

the PlantUMLClassesDiagramElement containing the plantUML classes diagram element of the current dependency type.

Since:

1.1.1

getAnnotationsDependencies

public 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.

Specified by:

getAnnotationsDependencies in interface DependencyType

Returns:

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

Since:

1.2.0

getFullName

public 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

Specified by:

getFullName in interface DependencyType

Returns:

the dependency full name.

Since:

1.0.0

getImportDependenciesCollection

public 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.

Specified by:

getImportDependenciesCollection in interface DependencyType

Returns:

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

Since:

1.0.0

getName

public String getName()

Gets the dependency name, usually the class name.

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

Specified by:

getName in interface DependencyType

Returns:

the dependency name.

Since:

1.0.0

See Also:

DependencyType.setFullName(String, String)

getPackageName

public String getPackageName()

Gets the dependency package name.

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

Specified by:

getPackageName in interface DependencyType

Returns:

the dependency package name.

Since:

1.0.0

See Also:

DependencyType.setFullName(String, String)

getParentExtensionsDependencies

public 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.

Specified by:

getParentExtensionsDependencies in interface DependencyType

Returns:

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

Since:

1.2.0

getParentImplementationsDependencies

public 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.

Specified by:

getParentImplementationsDependencies in interface DependencyType

Returns:

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

Since:

1.0.0

getPlantUMLClassesDiagramElement

public 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.

Specified by:

getPlantUMLClassesDiagramElement in interface DependencyType

Returns:

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

Since:

1.1.1

getPlantUMLClassesDiagramRelations

public Set<PlantUMLClassesDiagramRelation> getPlantUMLClassesDiagramRelations()

Gets the whole PlantUML classes diagram relations.

Specified by:

getPlantUMLClassesDiagramRelations in interface DependencyType

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.3

getPlantUMLClassesDiagramRelations

public 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).

Specified by:

getPlantUMLClassesDiagramRelations in interface DependencyType

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Since:

1.0.0

setFullName

public 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

Specified by:

setFullName in interface DependencyType

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:

DependencyType.getName(), DependencyType.getPackageName()

toString

public String toString()

Overrides:

toString in class Object

Since:

1.0.0