Package org.apache.sling.feature.extension.apiregions.api.config

Class ConfigurableEntityAddition

java.lang.Object

org.apache.sling.feature.extension.apiregions.api.config.AttributeableEntity

org.apache.sling.feature.extension.apiregions.api.config.ConfigurableEntityAddition

Direct Known Subclasses:

ConfigurationDescriptionAddition, FactoryConfigurationDescriptionAddition

public abstract class ConfigurableEntityAddition
extends AttributeableEntity

A description of an OSGi configuration addition This class is not thread safe.

Since:

1.8

Constructor Summary

Constructors

Constructor	Description
ConfigurableEntityAddition()	Create a new addition

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear the object and reset to defaults
protected jakarta.json.JsonObjectBuilder	createJson()	Convert this object into JSON
void	fromJSONObject(jakarta.json.JsonObject jsonObj)	Extract the metadata from the JSON object.
Map<String,PropertyDescriptionAddition>	getPropertyDescriptionAdditions()	Get the property additions

Methods inherited from class org.apache.sling.feature.extension.apiregions.api.config.AttributeableEntity

getAttributes, getBoolean, getInteger, getNumber, getString, getString, getStringArray, setDefaults, setString, setStringArray, toJSONObject

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigurableEntityAddition

public ConfigurableEntityAddition()

Create a new addition

Method Details

getPropertyDescriptionAdditions

public Map<String,PropertyDescriptionAddition> getPropertyDescriptionAdditions()

Get the property additions

Returns:

The map of property additions

clear

public void clear()

Clear the object and reset to defaults

Overrides:

clear in class AttributeableEntity

fromJSONObject

public void fromJSONObject(jakarta.json.JsonObject jsonObj)
                    throws IOException

Extract the metadata from the JSON object. This method first calls clear()

Overrides:

fromJSONObject in class AttributeableEntity

Parameters:

jsonObj - The JSON Object

Throws:

IOException - If JSON parsing fails

createJson

protected jakarta.json.JsonObjectBuilder createJson()
                                             throws IOException

Convert this object into JSON

Overrides:

createJson in class AttributeableEntity

Returns:

The json object builder

Throws:

IOException - If generating the JSON fails