io.apicurio.datamodels.core.models.common

Class Operation

java.lang.Object

io.apicurio.datamodels.core.models.Node

io.apicurio.datamodels.core.models.ExtensibleNode

io.apicurio.datamodels.core.models.common.Operation

All Implemented Interfaces:

IExternalDocumentationParent, IVisitable

Direct Known Subclasses:

AaiOperationBase, OasOperation

public abstract class Operation
extends ExtensibleNode
implements IExternalDocumentationParent

Author:

eric.wittmann@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
String	description
ExternalDocumentation	externalDocs
String	operationId
String	summary

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
Operation(String opType) Constructor.

Method Summary

Modifier and Type	Method and Description
void	accept(IVisitor visitor) Called to accept a visitor onto a visitable data model instance.
abstract ExternalDocumentation	createExternalDocumentation() Creates an External Documentation node.
String	getType() Gets the operation type.
void	setExternalDocumentation(ExternalDocumentation externalDocs) Sets the external documentation.
ExternalDocumentation	setExternalDocumentation(String description, String url) Sets the external documentation information.

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

operationId

public String operationId

summary

public String summary

description

public String description

externalDocs

public ExternalDocumentation externalDocs

Constructor Detail

Operation

public Operation(String opType)

Constructor.

Parameters:

opType -

Method Detail

getType

public String getType()

Gets the operation type.

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)

createExternalDocumentation

public abstract ExternalDocumentation createExternalDocumentation()

Creates an External Documentation node.

Specified by:

createExternalDocumentation in interface IExternalDocumentationParent

setExternalDocumentation

public void setExternalDocumentation(ExternalDocumentation externalDocs)

Description copied from interface: IExternalDocumentationParent

Sets the external documentation.

Specified by:

setExternalDocumentation in interface IExternalDocumentationParent

See Also:

IExternalDocumentationParent.setExternalDocumentation(io.apicurio.datamodels.core.models.common.ExternalDocumentation)

setExternalDocumentation

public ExternalDocumentation setExternalDocumentation(String description,
                                                      String url)

Sets the external documentation information.

Parameters:

description -

url -