Package de.iip_ecosphere.platform.configuration.aas

Class AasEnum

java.lang.Object

de.iip_ecosphere.platform.configuration.aas.AbstractAasElement

de.iip_ecosphere.platform.configuration.aas.AasEnum

public class AasEnum
extends AbstractAasElement

Represents an AAS enumeration.

Author:

Holger Eichelberger, SSE

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	isOpen
private List<AasEnumLiteral>	literals
private ParsingEnumKind	parsingEnumKind

Constructor Summary

Constructors

Constructor	Description
AasEnum(AasType type, ParsingEnumKind kind, Function<String,String> idShortModifier)	Turns a type into an enum.
AasEnum(String idShort)	Creates a new AAS enumeration.

Method Summary

Modifier and Type	Method	Description
(package private) void	addLiteral(AasEnumLiteral literal)	Adds a literal.
(package private) ParsingEnumKind	getParsingEnumKind()	Returns the internal/temporary parsing enum kind.
(package private) boolean	isLast(AasEnumLiteral literal)	Returns whether the given literal is the last one in literals().
boolean	isOpen()	Returns whether this enum shall be considered open for additions.
Iterable<AasEnumLiteral>	literals()	Returns the literals of this enum.
(package private) void	setIsOpen(boolean isOpen)	Defines whether this enum shall be considered open for additions.
(package private) void	setParsingEnumKind(ParsingEnumKind parsingEnumKind)	Defines the internal/temporary parsing enum kind, i.e., the kind of structure this enum was parsed/created from.

Methods inherited from class de.iip_ecosphere.platform.configuration.aas.AbstractAasElement

getDescription, getDisplayName, getIdShort, getIsCaseOf, getSemanticId, hasMultiSemanticIds, isGeneric, setDescription, setDisplayName, setGeneric, setIdShort, setIsCaseOf, setMultiSemanticIds, setSemanticId, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

literals

private List<AasEnumLiteral> literals

isOpen

private boolean isOpen

parsingEnumKind

private ParsingEnumKind parsingEnumKind

Constructor Details

AasEnum

public AasEnum(String idShort)

Creates a new AAS enumeration.

Parameters:

idShort - the idShort denoting the type

AasEnum

public AasEnum(AasType type,
 ParsingEnumKind kind,
 Function<String,String> idShortModifier)

Turns a type into an enum.

Parameters:

type - the type to take the data from

kind - the enum parsing kind

idShortModifier - optional modifier for the idShort, may be null

Method Details

setIsOpen

void setIsOpen(boolean isOpen)

Defines whether this enum shall be considered open for additions.

Parameters:

isOpen - whether this enum shall be considered open

isOpen

public boolean isOpen()

Returns whether this enum shall be considered open for additions.

Returns:

whether this enum shall be considered open

setParsingEnumKind

void setParsingEnumKind(ParsingEnumKind parsingEnumKind)

Defines the internal/temporary parsing enum kind, i.e., the kind of structure this enum was parsed/created from.

Parameters:

parsingEnumKind - the parsing enum kind

getParsingEnumKind

ParsingEnumKind getParsingEnumKind()

Returns the internal/temporary parsing enum kind.

Returns:

the parsing enum kind

addLiteral

void addLiteral(AasEnumLiteral literal)

Adds a literal.

Parameters:

literal - the literal

literals

public Iterable<AasEnumLiteral> literals()

Returns the literals of this enum.

Returns:

the literals

isLast

boolean isLast(AasEnumLiteral literal)

Returns whether the given literal is the last one in literals().

Parameters:

literal - the literal

Returns:

true for the last one, false else