Package io.openems.edge.core.appmanager

Class AppDef<APP extends OpenemsApp,PROPERTY extends Nameable,PARAMETER>

java.lang.Object

io.openems.edge.core.appmanager.AppDef<APP,PROPERTY,PARAMETER>

Type Parameters:

APP - the type of the app

PROPERTY - the type of the property

PARAMETER - the type of the paramters

All Implemented Interfaces:

OnlyIf<AppDef<APP,PROPERTY,PARAMETER>>, Self<AppDef<APP,PROPERTY,PARAMETER>>

public class AppDef<APP extends OpenemsApp,PROPERTY extends Nameable,PARAMETER>
extends Object
implements OnlyIf<AppDef<APP,PROPERTY,PARAMETER>>, Self<AppDef<APP,PROPERTY,PARAMETER>>

AppDef short for definition of a property for an app.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AppDef.FieldValuesBiPredicate<A,P,M,E>
static interface	AppDef.FieldValuesConsumer<A,P,M,T>	Functional interface with field values and a extra parameter.
static interface	AppDef.FieldValuesFunction<A,P,M,T,O>	Functional interface with field values and a extra parameter and and return value.
static interface	AppDef.FieldValuesPredicate<A,P,M>
static interface	AppDef.FieldValuesSupplier<A,P,M,O>	Functional interface function with field values.

Constructor Summary

Constructors

Constructor	Description
AppDef()

Method Summary

Modifier and Type	Method	Description
AppDef<APP,PROPERTY,PARAMETER>	also(Consumer<AppDef<APP,PROPERTY,PARAMETER>> consumer)	Executes the given Consumer with the current instance.
final AppDef<APP,PROPERTY,PARAMETER>	appendIsAllowedToEdit(AppDef.FieldValuesBiPredicate<? super APP,? super PROPERTY,? super PARAMETER,? super User>... isAllowedToEditPredicates)	Appends the given predicates and collections them into one which checks that every predicate returns true to determine if the current field can be edited.
final AppDef<APP,PROPERTY,PARAMETER>	appendIsAllowedToSee(AppDef.FieldValuesBiPredicate<? super APP,? super PROPERTY,? super PARAMETER,? super User>... isAllowedToSeePredicate)	Appends the given predicates and collections them into one which checks that every predicate returns true to determine if the current field should be show.
AppDef<APP,PROPERTY,PARAMETER>	bidirectional(PROPERTY propOfComponentId, String property, Function<? super APP,ComponentManager> componentManagerFunction)	Binds a property bidirectional.
AppDef<APP,PROPERTY,PARAMETER>	bidirectional(PROPERTY propOfComponentId, String property, Function<? super APP,ComponentManager> componentManagerFunction, Function<? super com.google.gson.JsonElement,com.google.gson.JsonElement> mapper)	Binds a property bidirectional.
static final <APP extends OpenemsApp, PROPERTY extends Nameable, PARAMETER> AppDef<APP,PROPERTY,PARAMETER>	componentId(String componentId)	Creates a AppDef with the componentId as the default value.
static final <APP extends AbstractOpenemsAppWithProps<APP, PROPERTY, PARAMETER> & OpenemsApp, PROPERTY extends Nameable & Type<PROPERTY, APP, PARAMETER>, PARAMETER extends Type.Parameter.BundleParameter> AppDef<APP,PROPERTY,PARAMETER>	copyOf(Class<PROPERTY> propertyClass, AppDef<OpenemsApp,Nameable,Type.Parameter.BundleParameter> otherDef)	Creates a copy of the otherDef.
static final <APP extends APPO, PROPERTY extends PROPERTYO, PARAMETER extends PARAMETERO, APPO extends OpenemsApp, PROPERTYO extends Nameable, PARAMETERO> AppDef<APP,PROPERTY,PARAMETER>	copyOfGeneric(AppDef<APPO,PROPERTYO,PARAMETERO> otherDef)	Creates a copy of the otherDef.
static final <APP extends APPO, PROPERTY extends PROPERTYO, PARAMETER extends PARAMETERO, APPO extends OpenemsApp, PROPERTYO extends Nameable, PARAMETERO> AppDef<APP,PROPERTY,PARAMETER>	copyOfGeneric(AppDef<APPO,PROPERTYO,PARAMETERO> otherDef, Consumer<AppDef<APP,PROPERTY,PARAMETER>> consumer)	Creates a copy of the otherDef.
static final <APP extends OpenemsApp, PROPERTY extends Nameable & Type<? extends PROPERTY, ? extends APP, ? extends PARAMETER>, PARAMETER extends Type.Parameter> AppDef<APP,PROPERTY,PARAMETER>	genericOf(Class<PROPERTY> propertyClass)	Creates a AppDef of a subclass of an OpenemsApp.
AppDef.FieldValuesFunction<? super APP,? super PROPERTY,? super PARAMETER,com.google.gson.JsonObject,com.google.gson.JsonElement>	getBidirectionalValue()	Gets the function to get the bidirectional value.
final AppDef.FieldValuesSupplier<? super APP,? super PROPERTY,? super PARAMETER,com.google.gson.JsonElement>	getDefaultValue()	Gets the function to get the label.
AppDef.FieldValuesSupplier<? super APP,? super PROPERTY,? super PARAMETER,String>	getDescription()	Gets the function to get the description.
final AppDef.FieldValuesSupplier<? super APP,? super PROPERTY,? super PARAMETER,FormlyBuilder<?>>	getField()	Gets the function to get the FormlyBuilder.
AppDef.FieldValuesBiPredicate<? super APP,? super PROPERTY,? super PARAMETER,? super User>	getIsAllowedToEdit()
AppDef.FieldValuesBiPredicate<? super APP,? super PROPERTY,? super PARAMETER,? super User>	getIsAllowedToSee()
AppDef.FieldValuesSupplier<? super APP,? super PROPERTY,? super PARAMETER,String>	getLabel()	Gets the function to get the label.
boolean	isAllowedToSave()	Gets if the property is allowed to be saved.
static Function<? super com.google.gson.JsonElement,com.google.gson.JsonElement>	multiplyWith(double multiplicator)	Creates a simple mapper if the input JsonElement is a number it gets multiplied with the given multiplicator.
static final <APP extends OpenemsApp, PROPERTY extends Nameable, PARAMETER> AppDef<APP,PROPERTY,PARAMETER>	of()	Creates a AppDef of a subclass of an AbstractOpenemsAppWithProps.
static final <APP extends AbstractOpenemsAppWithProps<APP, PROPERTY, PARAMETER>, PROPERTY extends Type<PROPERTY, APP, PARAMETER> & Nameable, PARAMETER extends Type.Parameter.BundleProvider> AppDef<APP,PROPERTY,PARAMETER>	of(Class<APP> clazz)	Creates a AppDef of a subclass of an AbstractOpenemsAppWithProps.
static AppDef.FieldValuesBiPredicate<? super Object,? super Object,? super Object,User>	ofLeastRole(Role role)	Creates a AppDef.FieldValuesBiPredicate to check if the Role of the user is at least the given Role.
AppDef<APP,PROPERTY,PARAMETER>	self()	Gets itself.
AppDef<APP,PROPERTY,PARAMETER>	setAllowedToSave(boolean isAllowedToSave)	Sets if the property is allowed to be saved.
AppDef<APP,PROPERTY,PARAMETER>	setAutoGenerateField(boolean autoGenerateField)
final AppDef<APP,PROPERTY,PARAMETER>	setDefaultValue(AppDef.FieldValuesSupplier<? super APP,? super PROPERTY,? super PARAMETER,com.google.gson.JsonElement> defaultValue)	Sets the function as the defaultValue.
final AppDef<APP,PROPERTY,PARAMETER>	setDefaultValue(Boolean b)	Wraps the Boolean in a JsonPrimitive and sets it as the default value with AppDef#setDefaultValue(Function).
final AppDef<APP,PROPERTY,PARAMETER>	setDefaultValue(Character c)	Wraps the Character in a JsonPrimitive and sets it as the default value with AppDef#setDefaultValue(Function).
final AppDef<APP,PROPERTY,PARAMETER>	setDefaultValue(Enum<?> e)	Wraps the name of the Enum in a JsonPrimitive and sets it as the default value with AppDef#setDefaultValue(Function).
final AppDef<APP,PROPERTY,PARAMETER>	setDefaultValue(Number n)	Wraps the Number in a JsonPrimitive and sets it as the default value with AppDef#setDefaultValue(Function).
final AppDef<APP,PROPERTY,PARAMETER>	setDefaultValue(String s)	Wraps the String in a JsonPrimitive and sets it as the default value with AppDef#setDefaultValue(Function).
final AppDef<APP,PROPERTY,PARAMETER>	setDefaultValueBoolean(AppDef.FieldValuesSupplier<? super APP,? super PROPERTY,? super PARAMETER,Boolean> defaultValue)	Sets the function as the defaultValue.
final AppDef<APP,PROPERTY,PARAMETER>	setDefaultValueCharacter(AppDef.FieldValuesSupplier<? super APP,? super PROPERTY,? super PARAMETER,Character> defaultValue)	Sets the function as the defaultValue.
final AppDef<APP,PROPERTY,PARAMETER>	setDefaultValueNumber(AppDef.FieldValuesSupplier<? super APP,? super PROPERTY,? super PARAMETER,Number> defaultValue)	Sets the function as the defaultValue.
final AppDef<APP,PROPERTY,PARAMETER>	setDefaultValueString(AppDef.FieldValuesSupplier<? super APP,? super PROPERTY,? super PARAMETER,String> defaultValue)	Sets the function as the defaultValue.
final AppDef<APP,PROPERTY,PARAMETER>	setDefaultValueToAppName()	Sets a function as the default value which returns the result of OpenemsApp.getName(Language).
final AppDef<APP,PROPERTY,PARAMETER>	setDescription(AppDef.FieldValuesSupplier<? super APP,? super PROPERTY,? super PARAMETER,String> description)	Sets the function as the description.
final <T extends FormlyBuilder<?>> AppDef<APP,PROPERTY,PARAMETER>	setField(Function<PROPERTY,T> fieldSupplier)	Sets the field of the input.
final <T extends FormlyBuilder<?>> AppDef<APP,PROPERTY,PARAMETER>	setField(Function<PROPERTY,T> fieldSupplier, AppDef.FieldValuesConsumer<APP,PROPERTY,PARAMETER,T> additionalSettings)	Sets the field of the input.
AppDef<APP,PROPERTY,PARAMETER>	setFieldFunction(AppDef.FieldValuesSupplier<? super APP,? super PROPERTY,? super PARAMETER,FormlyBuilder<?>> field)
AppDef<APP,PROPERTY,PARAMETER>	setIsAllowedToSee(AppDef.FieldValuesBiPredicate<? super APP,? super PROPERTY,? super PARAMETER,User> isAllowedToSee)
final AppDef<APP,PROPERTY,PARAMETER>	setLabel(AppDef.FieldValuesSupplier<? super APP,? super PROPERTY,? super PARAMETER,String> label)	Sets the function as the label.
final AppDef<APP,PROPERTY,PARAMETER>	setLabel(String label)	Sets the given string label as the return of the function label.
final AppDef<APP,PROPERTY,PARAMETER>	setTranslatedDescription(String key)	Sets the value of the translation as the description.
final AppDef<APP,PROPERTY,PARAMETER>	setTranslatedDescriptionWithAppPrefix(String key, Object... params)	Sets the value of the translation with the OpenemsApp.getAppId() as prefixed as the description.
final AppDef<APP,PROPERTY,PARAMETER>	setTranslatedLabel(String key, Object... params)	Sets the value of the translation as the label.
final AppDef<APP,PROPERTY,PARAMETER>	setTranslatedLabelWithAppPrefix(String key, Object... params)	Sets the value of the translation with the OpenemsApp.getAppId() as prefixed as the label.
final AppDef<APP,PROPERTY,PARAMETER>	setTranslationBundleSupplier(Function<PARAMETER,ResourceBundle> bundleSupplier)
final AppDef<APP,PROPERTY,PARAMETER>	wrapField(AppDef.FieldValuesConsumer<? super APP,? super PROPERTY,? super PARAMETER,FormlyBuilder<?>> wrapper)	Wraps the existing field.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.openems.edge.core.appmanager.OnlyIf

onlyIf

Constructor Details

AppDef

public AppDef()

Method Details

componentId

public static final <APP extends OpenemsApp,
PROPERTY extends Nameable,
PARAMETER>
AppDef<APP,PROPERTY,PARAMETER> componentId(String componentId)

Creates a AppDef with the componentId as the default value.

Type Parameters:

APP - the type of the OpenemsApp

PROPERTY - the type of the Nameable

PARAMETER - the type of the Type.Parameter

Parameters:

componentId - the id of the component

Returns:

the AppDef

of

public static final <APP extends OpenemsApp,
PROPERTY extends Nameable,
PARAMETER>
AppDef<APP,PROPERTY,PARAMETER> of()

Creates a AppDef of a subclass of an AbstractOpenemsAppWithProps.

Type Parameters:

APP - the type of the app

PROPERTY - the type of the property

PARAMETER - the type of the parameter

Returns:

the AppDef

of

public static final <APP extends AbstractOpenemsAppWithProps<APP,
PROPERTY,
PARAMETER>,
PROPERTY extends Type<PROPERTY,
APP,
PARAMETER> & Nameable,
PARAMETER extends Type.Parameter.BundleProvider>
AppDef<APP,PROPERTY,PARAMETER> of(Class<APP> clazz)

Creates a AppDef of a subclass of an AbstractOpenemsAppWithProps.

Type Parameters:

APP - the type of the app

PROPERTY - the type of the property

PARAMETER - the type of the parameter

Parameters:

clazz - the Class of the AbstractOpenemsAppWithProps

Returns:

the AppDef

genericOf

public static final <APP extends OpenemsApp,
PROPERTY extends Nameable & Type<? extends PROPERTY,
? extends APP,
? extends PARAMETER>,
PARAMETER extends Type.Parameter>
AppDef<APP,PROPERTY,PARAMETER> genericOf(Class<PROPERTY> propertyClass)

Creates a AppDef of a subclass of an OpenemsApp.

Type Parameters:

APP - the type of the app

PROPERTY - the type of the property

PARAMETER - the type of the parameter

Parameters:

propertyClass - the Class of the PROPERTY

Returns:

the AppDef

copyOf

public static final <APP extends AbstractOpenemsAppWithProps<APP,
PROPERTY,
PARAMETER> & OpenemsApp,
PROPERTY extends Nameable & Type<PROPERTY,
APP,
PARAMETER>,
PARAMETER extends Type.Parameter.BundleParameter>
AppDef<APP,PROPERTY,PARAMETER> copyOf(Class<PROPERTY> propertyClass,
 AppDef<OpenemsApp,Nameable,Type.Parameter.BundleParameter> otherDef)

Creates a copy of the otherDef.

Type Parameters:

APP - the type of the app

PROPERTY - the type of the property

PARAMETER - the type of the parameter

Parameters:

propertyClass - the class of the current property

otherDef - the other AppDef

Returns:

the new AppDef //

copyOfGeneric

public static final <APP extends APPO,
PROPERTY extends PROPERTYO,
PARAMETER extends PARAMETERO,
APPO extends OpenemsApp,
PROPERTYO extends Nameable,
PARAMETERO>
AppDef<APP,PROPERTY,PARAMETER> copyOfGeneric(AppDef<APPO,PROPERTYO,PARAMETERO> otherDef,
 Consumer<AppDef<APP,PROPERTY,PARAMETER>> consumer)

Creates a copy of the otherDef. This method is often used instead of the copyOfGeneric(AppDef) because the return type doesn't have to be set explicit if a method call is appended to the result of the method.

Type Parameters:

APP - the type of the app

PROPERTY - the type of the property

PARAMETER - the type of the parameter

APPO - the type of the app from the otherDef

PROPERTYO - the type of the property from the otherDef

PARAMETERO - the type of the parameter from the otherDef

Parameters:

otherDef - the other AppDef

consumer - the Consumer to set attributes of the AppDef

Returns:

the new AppDef

copyOfGeneric

public static final <APP extends APPO,
PROPERTY extends PROPERTYO,
PARAMETER extends PARAMETERO,
APPO extends OpenemsApp,
PROPERTYO extends Nameable,
PARAMETERO>
AppDef<APP,PROPERTY,PARAMETER> copyOfGeneric(AppDef<APPO,PROPERTYO,PARAMETERO> otherDef)

Creates a copy of the otherDef.

Type Parameters:

APP - the type of the app

PROPERTY - the type of the property

PARAMETER - the type of the parameter

APPO - the type of the app from the otherDef

PROPERTYO - the type of the property from the otherDef

PARAMETERO - the type of the parameter from the otherDef

Parameters:

otherDef - the other AppDef

Returns:

the new AppDef

setAllowedToSave

public AppDef<APP,PROPERTY,PARAMETER> setAllowedToSave(boolean isAllowedToSave)

Sets if the property is allowed to be saved. May be used for passwords and apiKeys.

DefaultValue: Boolean.TRUE

Parameters:

isAllowedToSave - if the property is allowed to be saved

Returns:

this

setTranslationBundleSupplier

public final AppDef<APP,PROPERTY,PARAMETER> setTranslationBundleSupplier(Function<PARAMETER,ResourceBundle> bundleSupplier)

isAllowedToSave

public boolean isAllowedToSave()

Gets if the property is allowed to be saved.

Returns:

if the property is allowed to be saved

setLabel

public final AppDef<APP,PROPERTY,PARAMETER> setLabel(AppDef.FieldValuesSupplier<? super APP,? super PROPERTY,? super PARAMETER,String> label)

Sets the function as the label.

Parameters:

label - the function to get the label

Returns:

this

setLabel

public final AppDef<APP,PROPERTY,PARAMETER> setLabel(String label)

Sets the given string label as the return of the function label.

Parameters:

label - the label to set

Returns:

this

setTranslatedLabel

public final AppDef<APP,PROPERTY,PARAMETER> setTranslatedLabel(String key,
 Object... params)

Sets the value of the translation as the label.

Note: If this method is used Type.translationBundleSupplier() must be overridden and return a non null value.

Parameters:

key - the key of the translation

params - the parameter of the translation

Returns:

this

setTranslatedLabelWithAppPrefix

public final AppDef<APP,PROPERTY,PARAMETER> setTranslatedLabelWithAppPrefix(String key,
 Object... params)

Sets the value of the translation with the OpenemsApp.getAppId() as prefixed as the label.

Note: If this method is used Type.translationBundleSupplier() must be overridden and return a non null value.

Parameters:

key - the key of the translation

params - the parameter of the translation

Returns:

this

setDescription

public final AppDef<APP,PROPERTY,PARAMETER> setDescription(AppDef.FieldValuesSupplier<? super APP,? super PROPERTY,? super PARAMETER,String> description)

Sets the function as the description.

Parameters:

description - the function to get the description

Returns:

this

setTranslatedDescription

public final AppDef<APP,PROPERTY,PARAMETER> setTranslatedDescription(String key)

Sets the value of the translation as the description.

Note: If this method is used Type.translationBundleSupplier() must be overridden and return a non null value.

Parameters:

key - the key of the translation

Returns:

this

setTranslatedDescriptionWithAppPrefix

public final AppDef<APP,PROPERTY,PARAMETER> setTranslatedDescriptionWithAppPrefix(String key,
 Object... params)

Sets the value of the translation with the OpenemsApp.getAppId() as prefixed as the description.

Note: If this method is used Type.translationBundleSupplier() must be overridden and return a non null value.

Parameters:

key - the key of the translation

params - the parameter of the translation

Returns:

this

setDefaultValue

public final AppDef<APP,PROPERTY,PARAMETER> setDefaultValue(AppDef.FieldValuesSupplier<? super APP,? super PROPERTY,? super PARAMETER,com.google.gson.JsonElement> defaultValue)

Sets the function as the defaultValue.

Parameters:

defaultValue - the function to get the defaultValue

Returns:

this

setDefaultValue

public final AppDef<APP,PROPERTY,PARAMETER> setDefaultValue(String s)

Wraps the String in a JsonPrimitive and sets it as the default value with AppDef#setDefaultValue(Function).

Parameters:

s - the String as the default value

Returns:

this

setDefaultValue

public final AppDef<APP,PROPERTY,PARAMETER> setDefaultValue(Enum<?> e)

Wraps the name of the Enum in a JsonPrimitive and sets it as the default value with AppDef#setDefaultValue(Function).

Parameters:

e - the Enum as the default value

Returns:

this

setDefaultValue

public final AppDef<APP,PROPERTY,PARAMETER> setDefaultValue(Boolean b)

Wraps the Boolean in a JsonPrimitive and sets it as the default value with AppDef#setDefaultValue(Function).

Parameters:

b - the Boolean as the default value

Returns:

this

setDefaultValue

public final AppDef<APP,PROPERTY,PARAMETER> setDefaultValue(Number n)

Wraps the Number in a JsonPrimitive and sets it as the default value with AppDef#setDefaultValue(Function).

Parameters:

n - the Number as the default value

Returns:

this

setDefaultValue

public final AppDef<APP,PROPERTY,PARAMETER> setDefaultValue(Character c)

Wraps the Character in a JsonPrimitive and sets it as the default value with AppDef#setDefaultValue(Function).

Parameters:

c - the Character as the default value

Returns:

this

setDefaultValueString

public final AppDef<APP,PROPERTY,PARAMETER> setDefaultValueString(AppDef.FieldValuesSupplier<? super APP,? super PROPERTY,? super PARAMETER,String> defaultValue)

Sets the function as the defaultValue.

Parameters:

defaultValue - the function to get the defaultValue

Returns:

this

setDefaultValueNumber

public final AppDef<APP,PROPERTY,PARAMETER> setDefaultValueNumber(AppDef.FieldValuesSupplier<? super APP,? super PROPERTY,? super PARAMETER,Number> defaultValue)

Sets the function as the defaultValue.

Parameters:

defaultValue - the function to get the defaultValue

Returns:

this

setDefaultValueBoolean

public final AppDef<APP,PROPERTY,PARAMETER> setDefaultValueBoolean(AppDef.FieldValuesSupplier<? super APP,? super PROPERTY,? super PARAMETER,Boolean> defaultValue)

Sets the function as the defaultValue.

Parameters:

defaultValue - the function to get the defaultValue

Returns:

this

setDefaultValueCharacter

public final AppDef<APP,PROPERTY,PARAMETER> setDefaultValueCharacter(AppDef.FieldValuesSupplier<? super APP,? super PROPERTY,? super PARAMETER,Character> defaultValue)

Sets the function as the defaultValue.

Parameters:

defaultValue - the function to get the defaultValue

Returns:

this

setDefaultValueToAppName

public final AppDef<APP,PROPERTY,PARAMETER> setDefaultValueToAppName()

Sets a function as the default value which returns the result of OpenemsApp.getName(Language).

Returns:

this

setFieldFunction

public AppDef<APP,PROPERTY,PARAMETER> setFieldFunction(AppDef.FieldValuesSupplier<? super APP,? super PROPERTY,? super PARAMETER,FormlyBuilder<?>> field)

setField

public final <T extends FormlyBuilder<?>>
AppDef<APP,PROPERTY,PARAMETER> setField(Function<PROPERTY,T> fieldSupplier,
 AppDef.FieldValuesConsumer<APP,PROPERTY,PARAMETER,T> additionalSettings)

Sets the field of the input.

Type Parameters:

T - the type of the input

Parameters:

fieldSupplier - the supplier to get the FormlyBuilder

additionalSettings - the additional settings on the input

Returns:

this

setField

public final <T extends FormlyBuilder<?>>
AppDef<APP,PROPERTY,PARAMETER> setField(Function<PROPERTY,T> fieldSupplier)

Sets the field of the input.

Type Parameters:

T - the type of the input

Parameters:

fieldSupplier - the supplier to get the FormlyBuilder

Returns:

this

setAutoGenerateField

public AppDef<APP,PROPERTY,PARAMETER> setAutoGenerateField(boolean autoGenerateField)

setIsAllowedToSee

public AppDef<APP,PROPERTY,PARAMETER> setIsAllowedToSee(AppDef.FieldValuesBiPredicate<? super APP,? super PROPERTY,? super PARAMETER,User> isAllowedToSee)

appendIsAllowedToSee

@SafeVarargs
public final AppDef<APP,PROPERTY,PARAMETER> appendIsAllowedToSee(AppDef.FieldValuesBiPredicate<? super APP,? super PROPERTY,? super PARAMETER,? super User>... isAllowedToSeePredicate)

Appends the given predicates and collections them into one which checks that every predicate returns true to determine if the current field should be show.

Parameters:

isAllowedToSeePredicate - the AppDef.FieldValuesBiPredicate

Returns:

this

appendIsAllowedToEdit

@SafeVarargs
public final AppDef<APP,PROPERTY,PARAMETER> appendIsAllowedToEdit(AppDef.FieldValuesBiPredicate<? super APP,? super PROPERTY,? super PARAMETER,? super User>... isAllowedToEditPredicates)

Appends the given predicates and collections them into one which checks that every predicate returns true to determine if the current field can be edited.

Parameters:

isAllowedToEditPredicates - the AppDef.FieldValuesBiPredicate

Returns:

this

getIsAllowedToEdit

public AppDef.FieldValuesBiPredicate<? super APP,? super PROPERTY,? super PARAMETER,? super User> getIsAllowedToEdit()

getIsAllowedToSee

public AppDef.FieldValuesBiPredicate<? super APP,? super PROPERTY,? super PARAMETER,? super User> getIsAllowedToSee()

wrapField

public final AppDef<APP,PROPERTY,PARAMETER> wrapField(AppDef.FieldValuesConsumer<? super APP,? super PROPERTY,? super PARAMETER,FormlyBuilder<?>> wrapper)

Wraps the existing field. If the existing field is not set the wrapper will not be executed.

Parameters:

wrapper - the wrapper of the current field

Returns:

this

getLabel

public AppDef.FieldValuesSupplier<? super APP,? super PROPERTY,? super PARAMETER,String> getLabel()

Gets the function to get the label.

Returns:

the function

getDescription

public AppDef.FieldValuesSupplier<? super APP,? super PROPERTY,? super PARAMETER,String> getDescription()

Gets the function to get the description.

Returns:

the function

getDefaultValue

public final AppDef.FieldValuesSupplier<? super APP,? super PROPERTY,? super PARAMETER,com.google.gson.JsonElement> getDefaultValue()

Gets the function to get the label.

Returns:

the function

getField

public final AppDef.FieldValuesSupplier<? super APP,? super PROPERTY,? super PARAMETER,FormlyBuilder<?>> getField()

Gets the function to get the FormlyBuilder.

Returns:

the function

getBidirectionalValue

public AppDef.FieldValuesFunction<? super APP,? super PROPERTY,? super PARAMETER,com.google.gson.JsonObject,com.google.gson.JsonElement> getBidirectionalValue()

Gets the function to get the bidirectional value.

This value may be obtained from a component

Returns:

the function to get the value

self

public AppDef<APP,PROPERTY,PARAMETER> self()

Description copied from interface: Self

Gets itself.

Specified by:

self in interface Self<APP extends OpenemsApp>

Returns:

this

also

public AppDef<APP,PROPERTY,PARAMETER> also(Consumer<AppDef<APP,PROPERTY,PARAMETER>> consumer)

Executes the given Consumer with the current instance.

Parameters:

consumer - the Consumer to be executed with this instance

Returns:

this

bidirectional

public AppDef<APP,PROPERTY,PARAMETER> bidirectional(PROPERTY propOfComponentId,
 String property,
 Function<? super APP,ComponentManager> componentManagerFunction)

Binds a property bidirectional.

The property itself will not be stored in the app configuration only in the component. If the user doesn't provide the value of a property and there is a bidirectional binding for it it will be filled up with the value of the bidirectional binding. If there is no component id in the configuration or the component doesn't exist or the property of the value is null then null is returned inside the bidirectional function.

Parameters:

propOfComponentId - the key to get the component id from a configuration

property - the property of the component

componentManagerFunction - the function to get the component manager

Returns:

this

bidirectional

public AppDef<APP,PROPERTY,PARAMETER> bidirectional(PROPERTY propOfComponentId,
 String property,
 Function<? super APP,ComponentManager> componentManagerFunction,
 Function<? super com.google.gson.JsonElement,com.google.gson.JsonElement> mapper)

Binds a property bidirectional.

The property itself will not be stored in the app configuration only in the component. If the user doesn't provide the value of a property and there is a bidirectional binding for it it will be filled up with the value of the bidirectional binding. If there is no component id in the configuration or the component doesn't exist or the property of the value is null then null is returned inside the bidirectional function.

Parameters:

propOfComponentId - the key to get the component id from a configuration

property - the property of the component

componentManagerFunction - the function to get the component manager

mapper - the mapper Function from the component to the actual value

Returns:

this

multiplyWith

public static Function<? super com.google.gson.JsonElement,com.google.gson.JsonElement> multiplyWith(double multiplicator)

Creates a simple mapper if the input JsonElement is a number it gets multiplied with the given multiplicator.

Parameters:

multiplicator - the multiplicator to be applied to the JsonElement

Returns:

the converter Function

ofLeastRole

public static AppDef.FieldValuesBiPredicate<? super Object,? super Object,? super Object,User> ofLeastRole(Role role)

Creates a AppDef.FieldValuesBiPredicate to check if the Role of the user is at least the given Role.

Parameters:

role - the compared Role

Returns:

the AppDef.FieldValuesBiPredicate