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

Class AbstractProgrammingLanguageContext

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CppProgrammingLanguageContext, JavaProgrammingLanguageContext

public abstract class AbstractProgrammingLanguageContext
extends Object
implements ProgrammingLanguageContext

An abstract implementation of the ProgrammingLanguageContext interface, providing common behaviors.

Since:

1.0.0

Version:

1.4.0

Author:

Benjamin Croizet (See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractProgrammingLanguageContext() Default constructor.
protected	AbstractProgrammingLanguageContext(Set<DisplayType> displayTypesOpts, Pattern displayPackageNamePatternOpt, Pattern displayNamePatternOpt) Medium constructor.
protected	AbstractProgrammingLanguageContext(Set<GenericDependency> parsedAndSeenDependencies, Set<DisplayType> displayTypesOpts, Pattern displayPackageNamePatternOpt, Pattern displayNamePatternOpt) Medium constructor.
protected	AbstractProgrammingLanguageContext(Set<GenericDependency> parsedAndSeenDependencies, Set<GenericDependency> parsedDependencies, Set<GenericDependency> potentialJavaLangSeenDependencies, Set<DisplayType> displayTypesOpts, Pattern displayPackageNamePatternOpt, Pattern displayNamePatternOpt) Full constructor.

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.
int	compareTo(ProgrammingLanguageContext o)
ProgrammingLanguageContext	deepClone()
boolean	equals(Object obj)
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.
int	hashCode()
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.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractProgrammingLanguageContext

protected AbstractProgrammingLanguageContext()

Default constructor.

Since:

1.0.0

AbstractProgrammingLanguageContext

protected AbstractProgrammingLanguageContext(Set<DisplayType> displayTypesOpts,
                                  Pattern displayPackageNamePatternOpt,
                                  Pattern displayNamePatternOpt)

Medium constructor.

Parameters:

displayTypesOpts - the Set of display types options which filter type to appear in the plantUML description, mustn't be null.

displayPackageNamePatternOpt - the Pattern which filter package name to appear in the plantUML description, mustn't be null.

displayNamePatternOpt - the Pattern which filter name to appear in the plantUML description, mustn't be null.

Since:

1.0.0

AbstractProgrammingLanguageContext

protected AbstractProgrammingLanguageContext(Set<GenericDependency> parsedAndSeenDependencies,
                                  Set<DisplayType> displayTypesOpts,
                                  Pattern displayPackageNamePatternOpt,
                                  Pattern displayNamePatternOpt)

Medium constructor.

Parameters:

parsedAndSeenDependencies - the original parsed and seen dependencies Set of GenericDependency to put in the context, mustn't be null.

displayTypesOpts - the Set of display types options which filter type to appear in the plantUML description, mustn't be null.

displayPackageNamePatternOpt - the Pattern which filter package name to appear in the plantUML description, mustn't be null.

displayNamePatternOpt - the Pattern which filter name to appear in the plantUML description, mustn't be null.

Since:

1.0.0

AbstractProgrammingLanguageContext

protected AbstractProgrammingLanguageContext(Set<GenericDependency> parsedAndSeenDependencies,
                                  Set<GenericDependency> parsedDependencies,
                                  Set<GenericDependency> potentialJavaLangSeenDependencies,
                                  Set<DisplayType> displayTypesOpts,
                                  Pattern displayPackageNamePatternOpt,
                                  Pattern displayNamePatternOpt)

Full constructor.

Parameters:

parsedAndSeenDependencies - the original parsed and seen dependencies Set of GenericDependency to put in the context, mustn't be null.

parsedDependencies - the original parsed dependencies Set of GenericDependency to put in the context, mustn't be null.

potentialJavaLangSeenDependencies - the original potential "java.lang" seen dependencies Set of GenericDependency to put in the context, mustn't be null.

displayTypesOpts - the Set of display types options which filter type to appear in the plantUML description, mustn't be null.

displayPackageNamePatternOpt - the Pattern which filter package name to appear in the plantUML description, mustn't be null.

displayNamePatternOpt - the Pattern which filter name to appear in the plantUML description, mustn't be null.

Since:

1.0.0

Method Detail

addParsedAndSeenDependencies

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

Specified by:

addParsedAndSeenDependencies in interface ProgrammingLanguageContext

Parameters:

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

Since:

1.0.0

addPotentialJavaLangSeenDependencies

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

Specified by:

addPotentialJavaLangSeenDependencies in interface ProgrammingLanguageContext

Parameters:

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

Since:

1.2.0

See Also:

ProgrammingLanguageContext.getPotentialJavaLangSeenDependencies(), ProgrammingLanguageContext.removePotentialJavaLangSeenDependency(String), ProgrammingLanguageContext.removeAllPotentialJavaLangSeenDependencyAndChangePackageToJavaLang()

addSeenDependencies

public void addSeenDependencies(GenericDependency dependency)

Adds the dependency in the seen dependencies in the context.

Specified by:

addSeenDependencies in interface ProgrammingLanguageContext

Parameters:

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

Since:

1.0.0

compareTo

public int compareTo(ProgrammingLanguageContext o)

Specified by:

compareTo in interface Comparable<ProgrammingLanguageContext>

Since:

1.0.0

deepClone

public ProgrammingLanguageContext deepClone()

Specified by:

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

Since:

1.0.0

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Since:

1.0

getParsedAndSeenDependencies

public Collection<GenericDependency> getParsedAndSeenDependencies()

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

Specified by:

getParsedAndSeenDependencies in interface ProgrammingLanguageContext

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

public Collection<GenericDependency> getParsedDependencies()

Gets all dependencies which have been parsed within the context.

Specified by:

getParsedDependencies in interface ProgrammingLanguageContext

Returns:

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

Since:

1.0.0

getParsedDependency

public GenericDependency getParsedDependency(String fullName)

Gets the dependency in the parsed context following its name.

Specified by:

getParsedDependency in interface ProgrammingLanguageContext

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

public GenericDependency getParsedOrSeenDependency(String fullName)

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

Specified by:

getParsedOrSeenDependency in interface ProgrammingLanguageContext

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

public PlantUMLClassesDiagram getPlantUMLClassesDiagram()

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

Specified by:

getPlantUMLClassesDiagram in interface ProgrammingLanguageContext

Returns:

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

Since:

1.1.1

getPotentialJavaLangSeenDependencies

public Collection<GenericDependency> getPotentialJavaLangSeenDependencies()

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

Specified by:

getPotentialJavaLangSeenDependencies in interface ProgrammingLanguageContext

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(), ProgrammingLanguageContext.removePotentialJavaLangSeenDependency(String), ProgrammingLanguageContext.removeAllPotentialJavaLangSeenDependencyAndChangePackageToJavaLang()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Since:

1.0.0

hasToDisplay

public boolean hasToDisplay(DisplayType displayType)

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

Specified by:

hasToDisplay in interface ProgrammingLanguageContext

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

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

Specified by:

removeAllPotentialJavaLangSeenDependencyAndChangePackageToJavaLang in interface ProgrammingLanguageContext

Since:

1.2.0

removePotentialJavaLangSeenDependency

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

Specified by:

removePotentialJavaLangSeenDependency in interface ProgrammingLanguageContext

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

toString

public String toString()

Overrides:

toString in class Object

Since:

1.0.0