Package org.apache.juneau.marshall

Class SchemaAnnotation

java.lang.Object

org.apache.juneau.marshall.SchemaAnnotation

public class SchemaAnnotation
extends Object

Utility classes and methods for the @Schema annotation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SchemaAnnotation.Builder	Builder class.

Field Summary

Fields

Modifier and Type	Field	Description
static final Schema	DEFAULT	Default value

Method Summary

Modifier and Type	Method	Description
static JsonMap	asMap(Schema a)	Converts the specified @Schema annotation into a generic map.
static SchemaAnnotation.Builder	create()	Instantiates a new builder for this class.
static boolean	empty(Schema a)	Returns true if the specified annotation contains all default values.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final Schema DEFAULT

Default value

Method Details

asMap

public static JsonMap asMap(Schema a)
                     throws ParseException

Converts the specified @Schema annotation into a generic map.

Parameters:

a - The annotation instance. Can be null (returns an empty map).

Returns:

The schema converted to a map, or an empty map if the annotation was null.

Throws:

ParseException - Malformed input encountered.

create

public static SchemaAnnotation.Builder create()

Instantiates a new builder for this class.

Returns:

A new builder object.

empty

public static boolean empty(Schema a)

Returns true if the specified annotation contains all default values.

Parameters:

a - The annotation to check. Can be null (returns true).

Returns:

true if the specified annotation contains all default values.