net.sourceforge.plantumldependency.cli.generic.type

Enum ImportType

java.lang.Object

java.lang.Enum<ImportType>

net.sourceforge.plantumldependency.cli.generic.type.ImportType

All Implemented Interfaces:

Serializable, Comparable<ImportType>, Displayable

public enum ImportType
extends Enum<ImportType>
implements Displayable

This enumerations represents all kind of import types which can be used following the programming language, for instance, in Java, two types can be used : standard imports and static imports. These types are naturally combined with a display options to know if they have to appear in the generated plantUML description file. This is be used to filter imports following their types.

Since:

1.1.1

Version:

1.4.0

Author:

Benjamin Croizet (

Enum Constant Summary

Enum Constants

Enum Constant and Description
NATIVE The native import type.
STANDARD The standard import type.
STATIC The static import type.

Field Summary

Fields

Modifier and Type	Field and Description
static Set<ImportType>	IMPORT_TYPES The Set containing all import types which are available.

Method Summary

Methods

Modifier and Type	Method and Description
DisplayType	getDisplayType() Gets the value of displayType.
boolean	isDisplayable(Set<DisplayType> displayTypesOptions, Pattern displayPackageNamePattern, Pattern displayNamePattern) Tells if the dependency has to be displayed following the passed display options (type, name and package name).
static ImportType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ImportType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NATIVE

public static final ImportType NATIVE

The native import type.

STANDARD

public static final ImportType STANDARD

The standard import type.

STATIC

public static final ImportType STATIC

The static import type.

Field Detail

IMPORT_TYPES

public static final Set<ImportType> IMPORT_TYPES

The Set containing all import types which are available.

Method Detail

values

public static ImportType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ImportType c : ImportType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ImportType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getDisplayType

public DisplayType getDisplayType()

Gets the value of displayType.

Returns:

the value of displayType.

Since:

1.1.1

isDisplayable

public boolean isDisplayable(Set<DisplayType> displayTypesOptions,
                    Pattern displayPackageNamePattern,
                    Pattern displayNamePattern)

Tells if the dependency has to be displayed following the passed display options (type, name and package name).

Specified by:

isDisplayable in interface Displayable

Parameters:

displayTypesOptions - the Set of display types options which filter type, mustn't be null, if empty, this method always returns false, mustn't be null.

displayPackageNamePattern - the Pattern which filter package name, mustn't be null.

displayNamePattern - the Pattern which filter name, mustn't be null.

Returns:

true if the dependency has to be displayed, false otherwise.

Since:

1.1.1