Class Option
- java.lang.Object
-
- org.apache.sling.feature.extension.apiregions.api.config.AttributeableEntity
-
- org.apache.sling.feature.extension.apiregions.api.config.DescribableEntity
-
- org.apache.sling.feature.extension.apiregions.api.config.Option
-
public class Option extends DescribableEntity
Option for a property value This class is not thread safe.
-
-
Constructor Summary
Constructors Constructor Description Option()
-
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.StringgetValue()Get the value for the optionvoidsetValue(String value)Set the value for the option-
Methods inherited from class org.apache.sling.feature.extension.apiregions.api.config.DescribableEntity
getDeprecated, getDescription, getEnforceOn, getSince, getTitle, setDeprecated, setDescription, setEnforceOn, setSince, setTitle
-
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 classDescribableEntity
-
fromJSONObject
public void fromJSONObject(jakarta.json.JsonObject jsonObj) throws IOExceptionExtract the metadata from the JSON object. This method first callsclear()- Overrides:
fromJSONObjectin classDescribableEntity- Parameters:
jsonObj- The JSON Object- Throws:
IOException- If JSON parsing fails
-
getValue
public String getValue()
Get the value for the option- Returns:
- the value or
null
-
setValue
public void setValue(String value)
Set the value for the option- Parameters:
value- the value to set
-
createJson
protected jakarta.json.JsonObjectBuilder createJson() throws IOExceptionConvert this object into JSON- Overrides:
createJsonin classDescribableEntity- Returns:
- The json object builder
- Throws:
IOException- If generating the JSON fails
-
-