io.apicurio.datamodels.openapi.v3.models

Class Oas30Example

java.lang.Object

io.apicurio.datamodels.core.models.Node

io.apicurio.datamodels.core.models.ExtensibleNode

io.apicurio.datamodels.openapi.v3.models.Oas30Example

All Implemented Interfaces:

INamed, IReferenceNode, IVisitable

Direct Known Subclasses:

Oas30ExampleDefinition

public class Oas30Example
extends ExtensibleNode
implements IReferenceNode, INamed

Models an OpenAPI 3.0.x example.

Author:

eric.wittmann@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
String	$ref
String	description
String	externalValue
String	summary
Object	value

Fields inherited from class io.apicurio.datamodels.core.models.ExtensibleNode

_extensions

Fields inherited from class io.apicurio.datamodels.core.models.Node

_attributes, _extraProperties, _modelId, _ownerDocument, _parent, _validationProblems

Constructor Summary

Constructors

Constructor and Description
Oas30Example(String name) Constructor.

Method Summary

Modifier and Type	Method and Description
void	accept(IVisitor visitor) Called to accept a visitor onto a visitable data model instance.
String	getName() Gets the definition name.
void	rename(String newName) Renames the definition.

Methods inherited from class io.apicurio.datamodels.core.models.ExtensibleNode

addExtension, clearExtensions, createExtension, getExtension, getExtensions, isExtensible, removeExtension

Methods inherited from class io.apicurio.datamodels.core.models.Node

addExtraProperty, addValidationProblem, clearAttributes, clearValidationProblems, getAttribute, getAttributeNames, getExtraProperty, getExtraPropertyNames, getValidationProblemCodes, getValidationProblems, getValidationProblemsFor, hasExtraProperties, modelId, ownerDocument, parent, removeExtraProperty, setAttribute

Methods inherited from class java.lang.Object

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

Field Detail

$ref

public String $ref

summary

public String summary

description

public String description

value

public Object value

externalValue

public String externalValue

Constructor Detail

Oas30Example

public Oas30Example(String name)

Constructor.

Parameters:

name -

Method Detail

getName

public String getName()

Description copied from interface: INamed

Gets the definition name.

Specified by:

getName in interface INamed

See Also:

INamed.getName()

rename

public void rename(String newName)

Description copied from interface: INamed

Renames the definition.

Specified by:

rename in interface INamed

See Also:

INamed.rename(java.lang.String)

accept

public void accept(IVisitor visitor)

Description copied from interface: IVisitable

Called to accept a visitor onto a visitable data model instance.

Specified by:

accept in interface IVisitable

Specified by:

accept in class Node

See Also:

Node.accept(io.apicurio.datamodels.core.visitors.IVisitor)