Package io.openems.edge.core.appmanager.dependency

Enum Class DependencyDeclaration.CreatePolicy

java.lang.Object

java.lang.Enum<DependencyDeclaration.CreatePolicy>

io.openems.edge.core.appmanager.dependency.DependencyDeclaration.CreatePolicy

All Implemented Interfaces:

Serializable, Comparable<DependencyDeclaration.CreatePolicy>, Constable

Enclosing class:

DependencyDeclaration

public static enum DependencyDeclaration.CreatePolicy
extends Enum<DependencyDeclaration.CreatePolicy>

Defines if the dependency app should get created when creating the parent app.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS	Always creates the dependent app except an OpenemsAppInstance is already created and not a dependency of another app.
IF_NOT_EXISTING	lazy singleton.
NEVER	Never allowed to create the app.

Method Summary

Modifier and Type	Method	Description
final boolean	isAllowedToCreate(List<OpenemsAppInstance> allInstances, String appId)	Determines if the app of the given appId is allowed to create.
static DependencyDeclaration.CreatePolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DependencyDeclaration.CreatePolicy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALWAYS

public static final DependencyDeclaration.CreatePolicy ALWAYS

Always creates the dependent app except an OpenemsAppInstance is already created and not a dependency of another app.

IF_NOT_EXISTING

public static final DependencyDeclaration.CreatePolicy IF_NOT_EXISTING

lazy singleton.

NEVER

public static final DependencyDeclaration.CreatePolicy NEVER

Never allowed to create the app.

Method Details

values

public static DependencyDeclaration.CreatePolicy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static DependencyDeclaration.CreatePolicy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

isAllowedToCreate

public final boolean isAllowedToCreate(List<OpenemsAppInstance> allInstances,
 String appId)

Determines if the app of the given appId is allowed to create. This does not mean an existing app can't be used as the dependency.

Parameters:

allInstances - all app instances

appId - the appId

Returns:

s true if the app is allowed to create