public abstract class DescribableEntity extends AttributeableEntity
Constructor and Description |
---|
DescribableEntity() |
Modifier and Type | Method and Description |
---|---|
void |
clear()
Clear the object and reset to defaults
|
protected javax.json.JsonObjectBuilder |
createJson()
Convert this object into JSON
|
void |
fromJSONObject(javax.json.JsonObject jsonObj)
Extract the metadata from the JSON object.
|
String |
getDeprecated()
Get the deprecation text
|
String |
getDescription()
Get the description
|
String |
getEnforceOn()
Get the optional since information
|
String |
getSince()
Get the optional since information
|
String |
getTitle()
Get the title
|
void |
setDeprecated(String deprecated)
Set the deprecation text
|
void |
setDescription(String description)
Set the description
|
void |
setEnforceOn(String enforceOn)
Set the enforce on information.
|
void |
setSince(String since)
Set the since information.
|
void |
setTitle(String title)
Set the title
|
getAttributes, getBoolean, getInteger, getNumber, getString, getString, getStringArray, setDefaults, setString, setStringArray, toJSONObject
public void clear()
clear
in class AttributeableEntity
public void fromJSONObject(javax.json.JsonObject jsonObj) throws IOException
clear()
fromJSONObject
in class AttributeableEntity
jsonObj
- The JSON ObjectIOException
- If JSON parsing failspublic String getTitle()
null
public void setTitle(String title)
title
- the title to setpublic String getDescription()
null
public void setDescription(String description)
description
- the description to setpublic String getDeprecated()
null
public void setDeprecated(String deprecated)
deprecated
- the deprecation text to setpublic String getSince()
null
public void setSince(String since)
since
- The new infopublic String getEnforceOn()
null
public void setEnforceOn(String enforceOn)
enforceOn
- The new infoprotected javax.json.JsonObjectBuilder createJson() throws IOException
createJson
in class AttributeableEntity
IOException
- If generating the JSON failsCopyright © 2007–2021 The Apache Software Foundation. All rights reserved.