org.apache.juneau.jsonschema

Class JsonSchemaClassMeta

java.lang.Object

org.apache.juneau.ClassMetaExtended

org.apache.juneau.jsonschema.JsonSchemaClassMeta

public class JsonSchemaClassMeta
extends ClassMetaExtended

Metadata on classes specific to the JSON-Schema serializer and pulled from the @JsonSchema annotation on the class.

Constructor Summary

Constructors

Constructor and Description
JsonSchemaClassMeta(ClassMeta<?> cm) Constructor.

Method Summary

Modifier and Type	Method and Description
protected JsonSchema	getAnnotation() Returns the @JsonSchema annotation defined on the class.
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.ClassMetaExtended

getClassMeta, getInnerClass

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonSchemaClassMeta

public JsonSchemaClassMeta(ClassMeta<?> cm)

Constructor.

Parameters:

cm - The class that this annotation is defined on.

Method Detail

getAnnotation

protected JsonSchema getAnnotation()

Returns the @JsonSchema annotation defined on the class.

Returns:

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

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.