Class PropertyDescriptionAddition
- java.lang.Object
-
- org.apache.sling.feature.extension.apiregions.api.config.AttributeableEntity
-
- org.apache.sling.feature.extension.apiregions.api.config.PropertyDescriptionAddition
-
public class PropertyDescriptionAddition extends AttributeableEntity
Instances of this class represent an addition to a configuration property This class is not thread safe.- Since:
- 1.8
-
-
Constructor Summary
Constructors Constructor Description PropertyDescriptionAddition()Create a new description
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclear()Clear the object and reset to defaultsprotected jakarta.json.JsonObjectBuildercreateJson()Convert this object into JSONvoidfromJSONObject(jakarta.json.JsonObject jsonObj)Extract the metadata from the JSON object.String[]getIncludes()Get the includesvoidsetIncludes(String[] includes)Set the includes-
Methods inherited from class org.apache.sling.feature.extension.apiregions.api.config.AttributeableEntity
getAttributes, getBoolean, getInteger, getNumber, getString, getString, getStringArray, setDefaults, setString, setStringArray, toJSONObject
-
-
-
-
Method Detail
-
clear
public void clear()
Clear the object and reset to defaults- Overrides:
clearin classAttributeableEntity
-
fromJSONObject
public void fromJSONObject(jakarta.json.JsonObject jsonObj) throws IOExceptionExtract the metadata from the JSON object. This method first callsclear()- Overrides:
fromJSONObjectin classAttributeableEntity- Parameters:
jsonObj- The JSON Object- Throws:
IOException- If JSON parsing fails
-
createJson
protected jakarta.json.JsonObjectBuilder createJson() throws IOExceptionConvert this object into JSON- Overrides:
createJsonin classAttributeableEntity- Returns:
- The json object builder
- Throws:
IOException- If generating the JSON fails
-
getIncludes
public String[] getIncludes()
Get the includes- Returns:
- the includes or
null
-
setIncludes
public void setIncludes(String[] includes)
Set the includes- Parameters:
includes- the includes to set
-
-