Package org.apache.juneau.annotation

Class ExternalDocsAnnotation

java.lang.Object

org.apache.juneau.annotation.ExternalDocsAnnotation

public class ExternalDocsAnnotation
extends Object

Utility classes and methods for the @ExternalDocs annotation.

See Also:

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final ExternalDocs	DEFAULT	Default value

Constructor Summary

Constructors

Constructor	Description
ExternalDocsAnnotation()

Method Summary

Modifier and Type	Method	Description
static ExternalDocsAnnotation.Builder	create()	Instantiates a new builder for this class.
static boolean	empty(ExternalDocs a)	Returns true if the specified annotation contains all default values.
static JsonMap	merge(JsonMap m, ExternalDocs a)	Merges the contents of the specified annotation into the specified generic map.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final ExternalDocs DEFAULT

Default value

Constructor Details

ExternalDocsAnnotation

public ExternalDocsAnnotation()

Method Details

create

public static ExternalDocsAnnotation.Builder create()

Instantiates a new builder for this class.

Returns:

A new builder object.

empty

public static boolean empty(ExternalDocs a)

Returns true if the specified annotation contains all default values.

Parameters:

a - The annotation to check.

Returns:

true if the specified annotation contains all default values.

merge

public static JsonMap merge(JsonMap m,
 ExternalDocs a)
                     throws ParseException

Merges the contents of the specified annotation into the specified generic map.

Parameters:

m - The map to copy the contents to.

a - The annotation to apply.

Returns:

The same map with the annotation contents applied.

Throws:

ParseException - Invalid JSON found in value.