Package io.openems.edge.app.common.props

Class CommonProps

java.lang.Object

io.openems.edge.app.common.props.CommonProps

public final class CommonProps
extends Object

Method Summary

Modifier and Type	Method	Description
static final AppDef<OpenemsApp,Nameable,Type.Parameter.BundleProvider>	alias()	Creates a AppDef for a alias.
static final AppDef<OpenemsApp,Nameable,Type.Parameter.BundleProvider>	defaultDef()	Creates a default AppDef with the AppDef.translationBundleSupplier set.
static final <APP extends OpenemsApp, PROP extends Nameable, PARAM extends Type.Parameter.BundleParameter> AppDef<APP,PROP,PARAM>	installationHint(AppDef.FieldValuesSupplier<APP,PROP,PARAM,String> firstText, AppDef.FieldValuesSupplier<APP,PROP,PARAM,String>... otherTexts)	Creates a AppDef for a installation hint.
static final <APP extends OpenemsApp, PROP extends Nameable, PARAM extends Type.Parameter.BundleParameter> AppDef<APP,PROP,PARAM>	installationHintOfUnofficialApp()	Creates a installation hint to warn the user that the current app is not an official app from the company of this edge.

Methods inherited from class java.lang.Object

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

Method Details

defaultDef

public static final AppDef<OpenemsApp,Nameable,Type.Parameter.BundleProvider> defaultDef()

Creates a default AppDef with the AppDef.translationBundleSupplier set.

Returns:

the AppDef

alias

public static final AppDef<OpenemsApp,Nameable,Type.Parameter.BundleProvider> alias()

Creates a AppDef for a alias.

Returns:

the AppDef

installationHint

@SafeVarargs
public static final <APP extends OpenemsApp,
PROP extends Nameable,
PARAM extends Type.Parameter.BundleParameter>
AppDef<APP,PROP,PARAM> installationHint(AppDef.FieldValuesSupplier<APP,PROP,PARAM,String> firstText,
 AppDef.FieldValuesSupplier<APP,PROP,PARAM,String>... otherTexts)

Creates a AppDef for a installation hint. Only displays the text of the supplier with a checkbox to accept these conditions. Also does not safe the value.

Type Parameters:

APP - the type of the OpenemsApp

PROP - the type of the Nameable

PARAM - the type of the Type.Parameter

Parameters:

firstText - the first text to ensure that there is at least one element

otherTexts - the additional texts of the conditions to accept

Returns:

the AppDef

installationHintOfUnofficialApp

public static final <APP extends OpenemsApp,
PROP extends Nameable,
PARAM extends Type.Parameter.BundleParameter>
AppDef<APP,PROP,PARAM> installationHintOfUnofficialApp()

Creates a installation hint to warn the user that the current app is not an official app from the company of this edge. This can be used for apps which are in a early beta testing stage.

Type Parameters:

APP - the type of the OpenemsApp

PROP - the type of the Nameable

PARAM - the type of the Type.Parameter

Returns:

the AppDef