org.apache.juneau.jsonschema

Class JsonSchemaBeanPropertyMeta

java.lang.Object

org.apache.juneau.BeanPropertyMetaExtended

org.apache.juneau.jsonschema.JsonSchemaBeanPropertyMeta

public class JsonSchemaBeanPropertyMeta
extends BeanPropertyMetaExtended

Metadata on bean properties specific to the JSON-Schema pulled from the @JsonSchema annotation on the bean property.

Field Summary

Fields

Modifier and Type	Field and Description
static JsonSchemaBeanPropertyMeta	DEFAULT Default instance.

Constructor Summary

Constructors

Constructor and Description
JsonSchemaBeanPropertyMeta(BeanPropertyMeta bpm) Constructor.

Method Summary

Modifier and Type	Method and Description
protected String	getDescription() Returns the @JsonSchema(description) annotation defined on the class.
protected Object	getExample() Returns the @JsonSchema(example) annotation defined on the class.
protected String	getFormat() Returns the @JsonSchema(format) annotation defined on the class.
protected String	getType() Returns the @JsonSchema(type) annotation defined on the class.

Methods inherited from class org.apache.juneau.BeanPropertyMetaExtended

getBeanPropertyMeta

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final JsonSchemaBeanPropertyMeta DEFAULT

Default instance.

Constructor Detail

JsonSchemaBeanPropertyMeta

public JsonSchemaBeanPropertyMeta(BeanPropertyMeta bpm)

Constructor.

Parameters:

bpm - The metadata of the bean property of this additional metadata.

Method Detail

getType

protected String getType()

Returns the @JsonSchema(type) annotation defined on the class.

Returns:

The value of the annotation, or null if not specified.

getFormat

protected String getFormat()

Returns the @JsonSchema(format) annotation defined on the class.

Returns:

The value of the annotation, or null if not specified.

getDescription

protected String getDescription()

Returns the @JsonSchema(description) annotation defined on the class.

Returns:

The value of the annotation, or null if not specified.

getExample

protected Object getExample()

Returns the @JsonSchema(example) annotation defined on the class.

Returns:

The value of the annotation, or null if not specified.