Package io.openems.common.types

Class EdgeConfig.Factory

java.lang.Object

io.openems.common.types.EdgeConfig.Factory

Enclosing class:

EdgeConfig

public static class EdgeConfig.Factory
extends Object

Represents an OpenEMS Component Factory.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EdgeConfig.Factory.Property	Represents a configuration option of an OpenEMS Component Factory.

Constructor Summary

Constructors

Constructor	Description
Factory(String id, String name, String description, EdgeConfig.Factory.Property[] properties, String[] natureIds)

Method Summary

Modifier and Type	Method	Description
static EdgeConfig.Factory	create(String factoryId, org.osgi.service.metatype.ObjectClassDefinition ocd, String[] natureIds)	Creates a EdgeConfig.Factory from an ObjectClassDefinition.
static EdgeConfig.Factory	fromJson(String factoryId, com.google.gson.JsonElement json)	Creates a Factory from JSON.
String	getDescription()	Gets the Description of the EdgeConfig.Factory.
String	getId()	Gets the ID of the EdgeConfig.Factory.
String	getName()	Gets the Name of the EdgeConfig.Factory.
String[]	getNatureIds()	Gets the Nature-IDs of the EdgeConfig.Factory.
EdgeConfig.Factory.Property[]	getProperties()	Gets the EdgeConfig.Factory.Propertys of the EdgeConfig.Factory.
Optional<EdgeConfig.Factory.Property>	getProperty(String key)	Gets the Property with the given key.
com.google.gson.JsonElement	getPropertyDefaultValue(String propertyId)	Gets the default value of a property.
com.google.gson.JsonObject	toJson()	Returns the Factory configuration as a JSON Object.
static List<EdgeConfig.Factory.Property>	toProperties(org.osgi.service.metatype.ObjectClassDefinition ocd)	Parses a ObjectClassDefinition to a list of EdgeConfig.Factory.Propertys.

Methods inherited from class java.lang.Object

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

Constructor Details

Factory

public Factory(String id,
 String name,
 String description,
 EdgeConfig.Factory.Property[] properties,
 String[] natureIds)

Method Details

create

public static EdgeConfig.Factory create(String factoryId,
 org.osgi.service.metatype.ObjectClassDefinition ocd,
 String[] natureIds)

Creates a EdgeConfig.Factory from an ObjectClassDefinition.

Parameters:

factoryId - the Factory-ID

ocd - the ObjectClassDefinition

natureIds - the Nature-IDs

Returns:

a EdgeConfig.Factory

toProperties

public static List<EdgeConfig.Factory.Property> toProperties(org.osgi.service.metatype.ObjectClassDefinition ocd)

Parses a ObjectClassDefinition to a list of EdgeConfig.Factory.Propertys.

Parameters:

ocd - the ObjectClassDefinition

Returns:

a list of EdgeConfig.Factory.Propertys

getId

public String getId()

Gets the ID of the EdgeConfig.Factory.

Returns:

the ID

getName

public String getName()

Gets the Name of the EdgeConfig.Factory.

Returns:

the name

getDescription

public String getDescription()

Gets the Description of the EdgeConfig.Factory.

Returns:

the description

getProperties

public EdgeConfig.Factory.Property[] getProperties()

Gets the EdgeConfig.Factory.Propertys of the EdgeConfig.Factory.

Returns:

an array of EdgeConfig.Factory.Propertys

getProperty

public Optional<EdgeConfig.Factory.Property> getProperty(String key)

Gets the Property with the given key.

Parameters:

key - the property key

Returns:

the Property

getPropertyDefaultValue

public com.google.gson.JsonElement getPropertyDefaultValue(String propertyId)

Gets the default value of a property.

Parameters:

propertyId - the Property ID

Returns:

the default value as JsonElement

getNatureIds

public String[] getNatureIds()

Gets the Nature-IDs of the EdgeConfig.Factory.

Returns:

the Nature-IDs

toJson

public com.google.gson.JsonObject toJson()

Returns the Factory configuration as a JSON Object.

 {
   natureIds: string[]
 }
 

Returns:

configuration as a JSON Object

fromJson

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

Creates a Factory from JSON.

Parameters:

factoryId - the Factory-ID

json - the JSON

Returns:

the Factory

Throws:

OpenemsError.OpenemsNamedException - on error