net.sourceforge.plantumldependency.cli.main.option.programminglanguage.context

Interface ProgrammingLanguageContext

All Superinterfaces:

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

All Known Implementing Classes:

AbstractProgrammingLanguageContext, CppProgrammingLanguageContext, JavaProgrammingLanguageContext

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

The interface which describes a context shared by all dependencies which are parsed. It is mainly used to save all treated dependencies but also global states.

Since:

1.0.0

Version:

1.4.0

Author:

Benjamin Croizet (

Method Summary

Methods

Modifier and Type	Method and Description
void	addParsedAndSeenDependencies(GenericDependency dependency) Adds the dependency in the parsed and seen dependencies in the context.
void	addPotentialJavaLangSeenDependencies(GenericDependency dependency) Adds the dependency in the parsed and seen dependencies in the context and marks it as a potential "java.lang" dependency.
void	addSeenDependencies(GenericDependency dependency) Adds the dependency in the seen dependencies in the context.
Collection<GenericDependency>	getParsedAndSeenDependencies() Gets all dependencies which have been seen (as import for instance) and parsed within the context.
Collection<GenericDependency>	getParsedDependencies() Gets all dependencies which have been parsed within the context.
GenericDependency	getParsedDependency(String fullName) Gets the dependency in the parsed context following its name.
GenericDependency	getParsedOrSeenDependency(String fullName) Gets the dependency in the parsed and seen context following its name.
PlantUMLClassesDiagram	getPlantUMLClassesDiagram() Gets the PlantUMLClassesDiagram instance representing the context, following display options (type, name and package name).
Collection<GenericDependency>	getPotentialJavaLangSeenDependencies() Gets all dependencies which have been marked as potential "java.lang" dependencies within the context.
boolean	hasToDisplay(DisplayType displayType) Tells if the following DisplayType is managed or not by this context.
void	removeAllPotentialJavaLangSeenDependencyAndChangePackageToJavaLang() Removes all the marked as potential "java.lang" dependencies from the context and change their package to "java.lang".
void	removePotentialJavaLangSeenDependency(String fullName) Remove the marked as potential "java.lang" dependency from the context.

Methods inherited from interface java.lang.Comparable

compareTo

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

deepClone

Method Detail

addParsedAndSeenDependencies

void addParsedAndSeenDependencies(GenericDependency dependency)

Adds the dependency in the parsed and seen dependencies in the context. If the dependency is already in the context, it is replaced.

Parameters:

dependency - the GenericDependency instance to add, mustn't be null.

Since:

1.0.0

addPotentialJavaLangSeenDependencies

void addPotentialJavaLangSeenDependencies(GenericDependency dependency)

Adds the dependency in the parsed and seen dependencies in the context and marks it as a potential "java.lang" dependency. This should be used when the dependency package can be known between the current package and the "java.lang" package because dependencies are read in a sequential way. If the dependency is already in the context, it is replaced.

Parameters:

dependency - the GenericDependency instance to add, mustn't be null.

Since:

1.2.0

See Also:

getPotentialJavaLangSeenDependencies(), removePotentialJavaLangSeenDependency(String), removeAllPotentialJavaLangSeenDependencyAndChangePackageToJavaLang()

addSeenDependencies

void addSeenDependencies(GenericDependency dependency)

Adds the dependency in the seen dependencies in the context.

Parameters:

dependency - the GenericDependency instance to add, mustn't be null.

Since:

1.0.0

getParsedAndSeenDependencies

Collection<GenericDependency> getParsedAndSeenDependencies()

Gets all dependencies which have been seen (as import for instance) and parsed within the context.

Returns:

the Collection of all GenericDependency which have been seen (as import for instance) and parsed and associated with this context.

Since:

1.0.0

getParsedDependencies

Collection<GenericDependency> getParsedDependencies()

Gets all dependencies which have been parsed within the context.

Returns:

the Collection of all GenericDependency which have been parsed and associated with this context.

Since:

1.0.0

getParsedDependency

GenericDependency getParsedDependency(String fullName)

Gets the dependency in the parsed context following its name.

Parameters:

fullName - the dependency full name to get, mustn't be null.

Returns:

the GenericDependency instance following its full name if found in the parsed context, null otherwise.

Since:

1.2.0

getParsedOrSeenDependency

GenericDependency getParsedOrSeenDependency(String fullName)

Gets the dependency in the parsed and seen context following its name.

Parameters:

fullName - the dependency full name to get, mustn't be null.

Returns:

the GenericDependency instance following its full name if found in the parsed and seen context, null otherwise.

Since:

1.0.0

getPlantUMLClassesDiagram

PlantUMLClassesDiagram getPlantUMLClassesDiagram()

Gets the PlantUMLClassesDiagram instance representing the context, following display options (type, name and package name).

Returns:

the plantUML diagram instance representing the context, following display types options.

Since:

1.1.1

getPotentialJavaLangSeenDependencies

Collection<GenericDependency> getPotentialJavaLangSeenDependencies()

Gets all dependencies which have been marked as potential "java.lang" dependencies within the context.

Returns:

the Collection of all GenericDependency which have been marked as potential "java.lang" dependencies within the context.

Since:

1.2.0

See Also:

#addPotentialJavaLangSeenDependencies(), removePotentialJavaLangSeenDependency(String), removeAllPotentialJavaLangSeenDependencyAndChangePackageToJavaLang()

hasToDisplay

boolean hasToDisplay(DisplayType displayType)

Tells if the following DisplayType is managed or not by this context.

Parameters:

displayType - the DisplayType, mustn't be null.

Returns:

true if the DisplayType is managed by the context, false otherwise.

Since:

1.0.0

removeAllPotentialJavaLangSeenDependencyAndChangePackageToJavaLang

void removeAllPotentialJavaLangSeenDependencyAndChangePackageToJavaLang()

Removes all the marked as potential "java.lang" dependencies from the context and change their package to "java.lang". This should be used at the end of the parsing process because it means that marked dependencies haven't been parsed.

Since:

1.2.0

removePotentialJavaLangSeenDependency

void removePotentialJavaLangSeenDependency(String fullName)

Remove the marked as potential "java.lang" dependency from the context. This should be used each time a new dependency is parsed. If the dependency full name isn't marked as potential "java.lang" dependency, this method doesn't do anything.

Parameters:

fullName - 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

Since:

1.2.0