public abstract class ProgrammingLanguage extends Object implements Comparable<ProgrammingLanguage>, Serializable
| Modifier and Type | Field and Description |
|---|---|
static ProgrammingLanguage |
CPP
The c++ programming language.
|
static ProgrammingLanguage |
JAVA
The java programming language.
|
| Modifier | Constructor and Description |
|---|---|
protected |
ProgrammingLanguage(String programmingLanguageName)
Default constructor.
|
| 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. |
public static final ProgrammingLanguage JAVA
public static final ProgrammingLanguage CPP
protected ProgrammingLanguage(String programmingLanguageName)
programmingLanguageName - the programming language name to get the instance from, mustn't be
null nor empty.public static Collection<ProgrammingLanguage> getProgrammingLanguageCollection()
Collection of all ProgrammingLanguage.Collection of all ProgrammingLanguage available.public static Set<String> getProgrammingLanguageNamesSet()
Set of all programming languages names.Set of all programming languages names available.public static ProgrammingLanguage valueOfIgnoringCase(String programmingLanguageName)
ProgrammingLanguage instance associated to the passed name. Throw an
IllegalArgumentException if the programming language name isn't recognized.programmingLanguageName - the programming language name to get the instance from, mustn't be
null nor empty.ProgrammingLanguage instance associated to the passed name if available.public int compareTo(ProgrammingLanguage o)
compareTo in interface Comparable<ProgrammingLanguage>public abstract ProgrammingLanguageContext createNewContext(Set<DisplayType> displayTypesOpts, Pattern displayPackageNamePattern, Pattern displayNamePattern)
ProgrammingLanguageContext following the language.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.ProgrammingLanguageContext instance.public String getName()
name.name.public abstract GenericDependency readDependencyFromFile(String sourceFileContent, ProgrammingLanguageContext programmingLanguageContext) throws PlantUMLDependencyException
String to build the
GenericDependency instance. This method also modify the
programmingLanguageContext parameter by adding read objects and the parsed
dependencies.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.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.PlantUMLDependencyException - if any parsing exception occurs while reading the source file.Copyright © 2014 Sourceforge. All rights reserved.