org.apache.juneau.dto.swagger

Class SwaggerElement

java.lang.Object

org.apache.juneau.dto.swagger.SwaggerElement

Direct Known Subclasses:

Contact, ExternalDocumentation, HeaderInfo, Info, Items, License, Operation, ParameterInfo, ResponseInfo, SchemaInfo, SecurityScheme, Swagger, Tag, Xml

public abstract class SwaggerElement
extends Object

Root class for all Swagger beans.

See Also:

• Overview > juneau-dto > Swagger

Constructor Summary

Constructors

Constructor and Description
SwaggerElement()

Method Summary

Modifier and Type	Method and Description
<T> T	get(String property, Class<T> type) Generic property getter.
Map<String,Object>	getExtraProperties() The map used to store 'extra' properties on the swagger element.
protected boolean	isStrict() Returns true if contents should be validated per the Swagger spec.
SwaggerElement	set(String property, Object value) Generic property setter.
protected SwaggerElement	strict() Sets strict mode on this bean.
protected SwaggerElement	strict(Object value) Sets strict mode on this bean.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SwaggerElement

public SwaggerElement()

Method Detail

isStrict

protected boolean isStrict()

Returns true if contents should be validated per the Swagger spec.

Returns:

true if contents should be validated per the Swagger spec.

strict

protected SwaggerElement strict()

Sets strict mode on this bean.

Returns:

This object (for method chaining).

strict

protected SwaggerElement strict(Object value)

Sets strict mode on this bean.

Parameters:

value - The new value for this property.
Non-boolean values will be converted to boolean using Boolean.valueOf(value.toString()).
Can be null (interpreted as false).

Returns:

This object (for method chaining).

getExtraProperties

@BeanProperty(value="*")
public Map<String,Object> getExtraProperties()

The map used to store 'extra' properties on the swagger element.

For example, the "$ref" field is not a part of the Swagger doc, but is often found since it is a part of the JSON-Schema spec.
This map allows you to store such properties.

This map is lazy-created once this method is called.

Returns:

The extra properties map.
It's an instance of LinkedHashMap.

get

public <T> T get(String property,
                 Class<T> type)

Generic property getter.

Can be used to retrieve non-standard Swagger fields such as "$ref".

Parameters:

property - The property name to retrieve.

type - The datatype to cast the value to.

Returns:

The property value, or null if the property does not exist or is not set.

set

public SwaggerElement set(String property,
                          Object value)

Generic property setter.

Can be used to set non-standard Swagger fields such as "$ref".

Parameters:

property - The property name to set.

value - The new value for the property.

Returns:

This object (for method chaining).

toString

public String toString()

Overrides:

toString in class Object