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

Class ProgrammingLanguage

java.lang.Object

net.sourceforge.plantumldependency.cli.main.option.programminglanguage.argument.ProgrammingLanguage

All Implemented Interfaces:

Serializable, Comparable<ProgrammingLanguage>

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

The abstract class which describes all supported programming language which can be reverse engineered.

Since:

1.0.0

Version:

1.4.0

Author:

Benjamin Croizet (See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ProgrammingLanguage	CPP The c++ programming language.
static ProgrammingLanguage	JAVA The java programming language.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProgrammingLanguage(String programmingLanguageName) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(ProgrammingLanguage o)
abstract ProgrammingLanguageContext	createNewContext(Set<DisplayType> displayTypesOpts, Pattern displayPackageNamePattern, Pattern displayNamePattern) Create a new ProgrammingLanguageContext following the language.
boolean	equals(Object obj)
String	getName() Gets the value of name.
static Collection<ProgrammingLanguage>	getProgrammingLanguageCollection() Gets the Collection of all ProgrammingLanguage.
static Set<String>	getProgrammingLanguageNamesSet() Gets the Set of all programming languages names.
int	hashCode()
abstract GenericDependency	readDependencyFromFile(String sourceFileContent, ProgrammingLanguageContext programmingLanguageContext) Reads the following source file content as a String to build the GenericDependency instance.
String	toString()
static ProgrammingLanguage	valueOfIgnoringCase(String programmingLanguageName) Gets the ProgrammingLanguage instance associated to the passed name.

Methods inherited from class java.lang.Object

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

Field Detail

JAVA

public static final ProgrammingLanguage JAVA

The java programming language.

CPP

public static final ProgrammingLanguage CPP

The c++ programming language.

Constructor Detail

ProgrammingLanguage

protected ProgrammingLanguage(String programmingLanguageName)

Default constructor.

Parameters:

programmingLanguageName - the programming language name to get the instance from, mustn't be null nor empty.

Since:

1.0.0

Method Detail

getProgrammingLanguageCollection

public static Collection<ProgrammingLanguage> getProgrammingLanguageCollection()

Gets the Collection of all ProgrammingLanguage.

Returns:

the Collection of all ProgrammingLanguage available.

Since:

1.0.0

getProgrammingLanguageNamesSet

public static Set<String> getProgrammingLanguageNamesSet()

Gets the Set of all programming languages names.

Returns:

the Set of all programming languages names available.

Since:

1.0.0

valueOfIgnoringCase

public static ProgrammingLanguage valueOfIgnoringCase(String programmingLanguageName)

Gets the ProgrammingLanguage instance associated to the passed name. Throw an IllegalArgumentException if the programming language name isn't recognized.

Parameters:

programmingLanguageName - the programming language name to get the instance from, mustn't be null nor empty.

Returns:

the ProgrammingLanguage instance associated to the passed name if available.

Since:

1.0.0

compareTo

public int compareTo(ProgrammingLanguage o)

Specified by:

compareTo in interface Comparable<ProgrammingLanguage>

Since:

1.0.0

createNewContext

public abstract ProgrammingLanguageContext createNewContext(Set<DisplayType> displayTypesOpts,
                                          Pattern displayPackageNamePattern,
                                          Pattern displayNamePattern)

Create a new ProgrammingLanguageContext following the language.

Parameters:

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

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

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

Returns:

a new empty ProgrammingLanguageContext instance.

Since:

1.0.0

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Since:

1.0.0

getName

public String getName()

Gets the value of name.

Returns:

the value of name.

Since:

1.0.0

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Since:

1.0.0

readDependencyFromFile

public abstract GenericDependency readDependencyFromFile(String sourceFileContent,
                                       ProgrammingLanguageContext programmingLanguageContext)
                                                  throws PlantUMLDependencyException

Reads the following source file content as a String to build the GenericDependency instance. This method also modify the programmingLanguageContext parameter by adding read objects and the parsed dependencies.

Parameters:

sourceFileContent - the source file content as a String to read, mustn't be null. Should contain the expected programming language.

programmingLanguageContext - the context instance containing all dependencies which have already been seen in previous treatment, and other information which can be shared when parsing several source files, mustn't be null.

Returns:

the GenericDependency instance if it has been found and correctly parsed, null otherwise. May also be null if the context display types options doesn't manage the dependency type.

Throws:

PlantUMLDependencyException - if any parsing exception occurs while reading the source file.

Since:

1.0.0

toString

public String toString()

Overrides:

toString in class Object

Since:

1.0.0