Package io.openems.common.types

Class EdgeConfig.Factory.Property

java.lang.Object

io.openems.common.types.EdgeConfig.Factory.Property

Enclosing class:

EdgeConfig.Factory

public static class EdgeConfig.Factory.Property
extends Object

Represents a configuration option of an OpenEMS Component Factory.

Constructor Summary

Constructors

Constructor	Description
Property(String id, String name, String description, OpenemsType type, boolean isRequired, boolean isPassword, com.google.gson.JsonElement defaultValue, com.google.gson.JsonObject schema)

Method Summary

Modifier and Type	Method	Description
static EdgeConfig.Factory.Property	from(org.osgi.service.metatype.AttributeDefinition ad)	Creates a EdgeConfig.Factory.Property from an AttributeDefinition.
static EdgeConfig.Factory.Property	fromJson(com.google.gson.JsonElement json)	Creates a Property from JSON.
com.google.gson.JsonElement	getDefaultValue()	Gets the default value of the Property.
String	getDescription()	Gets the Description of the EdgeConfig.Factory.Property.
String	getId()	Gets the ID of the EdgeConfig.Factory.Property.
String	getName()	Gets the Name of the EdgeConfig.Factory.Property.
OpenemsType	getType()	Gets the OpenemsType of the EdgeConfig.Factory.Property.
boolean	isPassword()	Does this Property represent a password?.
boolean	isRequired()	Is this Property required?.
com.google.gson.JsonObject	toJson()	Returns the Factory Property as a JSON Object.

Methods inherited from class java.lang.Object

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

Constructor Details

Property

public Property(String id,
 String name,
 String description,
 OpenemsType type,
 boolean isRequired,
 boolean isPassword,
 com.google.gson.JsonElement defaultValue,
 com.google.gson.JsonObject schema)

Method Details

from

public static EdgeConfig.Factory.Property from(org.osgi.service.metatype.AttributeDefinition ad)

Creates a EdgeConfig.Factory.Property from an AttributeDefinition.

Parameters:

ad - the AttributeDefinition

Returns:

the EdgeConfig.Factory.Property

fromJson

public static EdgeConfig.Factory.Property fromJson(com.google.gson.JsonElement json)
                                            throws OpenemsError.OpenemsNamedException

Creates a Property from JSON.

Parameters:

json - the JSON

Returns:

the Property

Throws:

OpenemsError.OpenemsNamedException - on error

toJson

public com.google.gson.JsonObject toJson()

Returns the Factory Property as a JSON Object.

 {
   id: string,
   name: string,
   description: string,
   isOptional: boolean,
   isPassword: boolean,
   defaultValue: any,
   schema: {
     type: string
   }
 }
 

Returns:

property as a JSON Object

getId

public String getId()

Gets the ID of the EdgeConfig.Factory.Property.

Returns:

the Property-ID

getName

public String getName()

Gets the Name of the EdgeConfig.Factory.Property.

Returns:

the Name

getDescription

public String getDescription()

Gets the Description of the EdgeConfig.Factory.Property.

Returns:

the Description

getType

public OpenemsType getType()

Gets the OpenemsType of the EdgeConfig.Factory.Property.

Returns:

the OpenemsType

isPassword

public boolean isPassword()

Does this Property represent a password?.

Returns:

true if it is a password

isRequired

public boolean isRequired()

Is this Property required?.

Returns:

true if it is required

getDefaultValue

public com.google.gson.JsonElement getDefaultValue()

Gets the default value of the Property.

Returns:

the default value