net.sourceforge.plantumldependency.cli.main.option.programminglanguage.argument.java.type

Class JavaType

java.lang.Object

net.sourceforge.plantumldependency.cli.main.option.programminglanguage.argument.java.type.JavaType

All Implemented Interfaces:

Serializable, Comparable<JavaType>

public abstract class JavaType
extends Object
implements Comparable<JavaType>, Serializable

The abstract class which describes all existing java types such as classes, interfaces, enumerations and annotations.

Since:

1.0.0

Version:

1.3.0

Author:

Benjamin Croizet (See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static JavaType	ANNOTATION The "annotation" java type.
static JavaType	CLASS The "class" java type.
static JavaType	ENUM The "enum" java type.
static JavaType	INTERFACE The "interface" java type.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JavaType(String programmingLanguageKeyword) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(JavaType o)
abstract DependencyType	createAnnotationDependencyType(String annotationName, String annotationPackageName) Creates the annotation DependencyType instance associated to the current java type following the passed parameters.
abstract DependencyType	createDependencyType(String dependencyName, String dependencyPackageName, boolean isAbstract, ImportDependenciesCollection importDependencies, Set<GenericDependency> parentExtensionsDependencies, Set<GenericDependency> parentImplementationsDependencies, Set<GenericDependency> annotationDependencies) Creates the DependencyType instance associated to the current java type following passed parameters.
abstract DependencyType	createParentDependencyType(JavaParentType parentType, String parentName, String parentPackageName) Creates the parent DependencyType instance associated to the current java type following the JavaParentType and passed parameters.
boolean	equals(Object obj)
abstract boolean	extractNativeMethods(String javaSourceFileContent) Parses and extracts the java source file content to know if it contains links to native code through native methods.
abstract Set<String>	extractParentExtensions(String extendsString) Parses and extracts the Set of parent dependency names of type JavaParentType.EXTENSION from the passed String.
abstract Set<String>	extractParentImplementations(String implementsString) Parses and extracts the Set of parent dependency names of type JavaParentType.IMPLEMENTATION from the passed String.
protected Set<String>	extractParents(String parentsString) Generic method to parse and extract the Set of parent dependency names of any type from the passed String.
static Collection<JavaType>	getJavaTypeCollection() Gets the Collection of all JavaType.
String	getLanguageKeyword() Gets the value of languageKeyword.
int	hashCode()
String	toString()
static JavaType	valueOfIgnoringCase(String javaTypeKeyword) Gets the JavaType instance associated to the passed java type language keyword.

Methods inherited from class java.lang.Object

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

Field Detail

ANNOTATION

public static final JavaType ANNOTATION

The "annotation" java type.

CLASS

public static final JavaType CLASS

The "class" java type.

ENUM

public static final JavaType ENUM

The "enum" java type.

INTERFACE

public static final JavaType INTERFACE

The "interface" java type.

Constructor Detail

JavaType

protected JavaType(String programmingLanguageKeyword)

Default constructor.

Parameters:

programmingLanguageKeyword - The java type language keyword, mustn't be null.

Since:

1.3.0

Method Detail

getJavaTypeCollection

public static Collection<JavaType> getJavaTypeCollection()

Gets the Collection of all JavaType.

Returns:

the Collection of all JavaType available.

Since:

1.3.0

valueOfIgnoringCase

public static JavaType valueOfIgnoringCase(String javaTypeKeyword)

Gets the JavaType instance associated to the passed java type language keyword. Throw an IllegalArgumentException if the java type name isn't recognized.

Parameters:

javaTypeKeyword - the java type language keyword to get the instance from, mustn't be null nor empty.

Returns:

the JavaType instance associated to the passed java type language keyword if available.

Since:

1.3.0

compareTo

public int compareTo(JavaType o)

Specified by:

compareTo in interface Comparable<JavaType>

Since:

1.3.0

createAnnotationDependencyType

public abstract DependencyType createAnnotationDependencyType(String annotationName,
                                            String annotationPackageName)
                                                       throws PlantUMLDependencyException

Creates the annotation DependencyType instance associated to the current java type following the passed parameters.

Parameters:

annotationName - the dependency annotation name, such as "String", mustn't be null.

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

Returns:

the DependencyType instance which is an annotation of the current java type, following the passed parameters.

Throws:

PlantUMLDependencyException - if the requested java annotation type is incompatible with the current java type.

Since:

1.2.0

createDependencyType

public abstract DependencyType createDependencyType(String dependencyName,
                                  String dependencyPackageName,
                                  boolean isAbstract,
                                  ImportDependenciesCollection importDependencies,
                                  Set<GenericDependency> parentExtensionsDependencies,
                                  Set<GenericDependency> parentImplementationsDependencies,
                                  Set<GenericDependency> annotationDependencies)

Creates the DependencyType instance associated to the current java type following passed parameters.

Parameters:

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

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

isAbstract - the boolean telling if the java dependency is abstract or not.

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

parentExtensionsDependencies - the Set of all GenericDependency which are extended, mustn't be null.

parentImplementationsDependencies - the Set of all GenericDependency which are implemented, mustn't be null.

annotationDependencies - the Set of all GenericDependency which are used as annotation, mustn't be null.

Returns:

the DependencyType instance, following the current java type and the passed parameters.

Since:

1.3.0

createParentDependencyType

public abstract DependencyType createParentDependencyType(JavaParentType parentType,
                                        String parentName,
                                        String parentPackageName)
                                                   throws PlantUMLDependencyException

Creates the parent DependencyType instance associated to the current java type following the JavaParentType and passed parameters.

Parameters:

parentType - the JavaParentType instance, mustn't be null.

parentName - the dependency parent name, such as "String", mustn't be null.

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

Returns:

the DependencyType instance which is the parent of the current java type, following the java java type and the passed parameters.

Throws:

PlantUMLDependencyException - if the requested java parent type is incompatible with the current java type.

Since:

1.3.0

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Since:

1.3.0

extractNativeMethods

public abstract boolean extractNativeMethods(String javaSourceFileContent)

Parses and extracts the java source file content to know if it contains links to native code through native methods.

Parameters:

javaSourceFileContent - the java source file content to analyze as a String, mustn't be null.

Returns:

true if the dependency contains native methods, false otherwise.

Since:

1.3.0

extractParentExtensions

public abstract Set<String> extractParentExtensions(String extendsString)
                                             throws PlantUMLDependencyException

Parses and extracts the Set of parent dependency names of type JavaParentType.EXTENSION from the passed String.

Parameters:

extendsString - the String which describes the dependencies which are extended by the current java type.

For instance it can be :
Comparable, Cloneable
Number

Returns:

the Set of parent dependency names parsed from the String.

Throws:

PlantUMLDependencyException - if the requested parent dependency names are incompatible with the current java type.

Since:

1.3.0

extractParentImplementations

public abstract Set<String> extractParentImplementations(String implementsString)
                                                  throws PlantUMLDependencyException

Parses and extracts the Set of parent dependency names of type JavaParentType.IMPLEMENTATION from the passed String.

Parameters:

implementsString - the String which describes the dependencies which are implemented by the current java type.

For instance it can be :
Serializable, Cloneable
Number

Returns:

the Set of parent dependency names parsed from the String.

Throws:

PlantUMLDependencyException - if the requested parent dependency names are incompatible with the current java type.

Since:

1.3.0

extractParents

protected Set<String> extractParents(String parentsString)

Generic method to parse and extract the Set of parent dependency names of any type from the passed String.

Parameters:

parentsString - the String which describes the parents dependencies of the current java type.

For instance it can be :
Serializable, Cloneable
Number

Returns:

the Set of parent dependency names parsed from the String.

Since:

1.3.0

getLanguageKeyword

public String getLanguageKeyword()

Gets the value of languageKeyword.

Returns:

the value of languageKeyword.

Since:

1.3.0

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Since:

1.3.0

toString

public String toString()

Overrides:

toString in class Object

Since:

1.3.0