Class JsonSchemaOutputObjectProperty

java.lang.Object

de.xima.fc.prompt.service.support.JsonSchemaOutputObjectProperty

All Implemented Interfaces:

Serializable

public final class JsonSchemaOutputObjectProperty
extends Object
implements Serializable

One of the properties of a JSON object schema, used in JsonSchemaOutputByPropertyList.

Since:

8.5.0

See Also:

• JsonSchemaOutputByPropertyList
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
JsonSchemaOutputObjectProperty()

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets the description of the property.
String	getName()	Gets the name of the property the JSON object should have.
EJsonSchemaOutputPropertyType	getType()	Gets the data type of the property.
boolean	isRequired()	Whether the property is required or optional.
void	setDescription(String description)	Sets the description of the property.
void	setName(String name)	Sets the name of the property the JSON object should have.
void	setRequired(boolean required)	Sets whether the property is required or optional.
void	setType(EJsonSchemaOutputPropertyType type)	Sets the data type of the property.

Methods inherited from class Object

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

Constructor Details

JsonSchemaOutputObjectProperty

public JsonSchemaOutputObjectProperty()

Method Details

getDescription

public String getDescription()

Gets the description of the property. This is optional, but may be useful to aid the prompt service provider in understanding the purpose of the property.

Returns:

The description of the property.

setDescription

public void setDescription(String description)

Sets the description of the property. This is optional, but may be useful to aid the prompt service provider in understanding the purpose of the property.

Parameters:

description - The description of the property.

getName

public String getName()

Gets the name of the property the JSON object should have.

Returns:

The name of the property.

setName

public void setName(String name)

Sets the name of the property the JSON object should have.

Parameters:

name - The name of the property.

getType

public EJsonSchemaOutputPropertyType getType()

Gets the data type of the property.

Returns:

The data type of the property.

setType

public void setType(EJsonSchemaOutputPropertyType type)

Sets the data type of the property.

Parameters:

type - The data type of the property.

isRequired

public boolean isRequired()

Whether the property is required or optional. An optional property may be omitted in the JSON object or set to null.

Returns:

True if the property is required, false if it is optional.

setRequired

public void setRequired(boolean required)

Sets whether the property is required or optional. An optional property may be omitted in the JSON object or set to null.

Parameters:

required - True if the property is required, false if it is optional.