io.apicurio.datamodels.openapi.v3.models

Class Oas30Link

java.lang.Object

io.apicurio.datamodels.core.models.Node

io.apicurio.datamodels.core.models.ExtensibleNode

io.apicurio.datamodels.openapi.v3.models.Oas30Link

All Implemented Interfaces:

INamed, IReferenceNode, IVisitable

Direct Known Subclasses:

Oas30LinkDefinition

public class Oas30Link
extends ExtensibleNode
implements INamed, IReferenceNode

Models an OpenAPI 3.0.x Link.

Author:

eric.wittmann@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
String	$ref
String	description
String	operationId
String	operationRef
Map<String,Oas30LinkParameterExpression>	parameters
Oas30LinkRequestBodyExpression	requestBody
Oas30LinkServer	server

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
Oas30Link(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.
Oas30LinkParameterExpression	addLinkParameter(String name, String expression) Adds a link parameter expression.
void	addLinkParameterExpression(String name, Oas30LinkParameterExpression expression) Adds a link parameter expression.
Oas30LinkParameterExpression	createLinkParameterExpression(String name, String value) Creates a link parameter expression.
Oas30LinkRequestBodyExpression	createLinkRequestBodyExpression(String value) Creates a link request body expression.
Oas30LinkServer	createServer() Creates an OAS 3.0 Server object.
Oas30LinkParameterExpression	getLinkParameterExpression(String name) Gets a single link parameter expression by name.
List<Oas30LinkParameterExpression>	getLinkParameterExpressions() Gets a list of all link parameter expressions.
String	getName() Gets the definition name.
Oas30LinkParameterExpression	removeLinkParameterExpression(String name) Removes a single link parameter expression and returns it.
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

operationRef

public String operationRef

operationId

public String operationId

parameters

public Map<String,Oas30LinkParameterExpression> parameters

requestBody

public Oas30LinkRequestBodyExpression requestBody

description

public String description

server

public Oas30LinkServer server

Constructor Detail

Oas30Link

public Oas30Link(String name)

Constructor.

Parameters:

name -

Method Detail

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)

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)

createLinkParameterExpression

public Oas30LinkParameterExpression createLinkParameterExpression(String name,
                                                                  String value)

Creates a link parameter expression.

Parameters:

name -

value -

addLinkParameterExpression

public void addLinkParameterExpression(String name,
                                       Oas30LinkParameterExpression expression)

Adds a link parameter expression.

Parameters:

name -

expression -

addLinkParameter

public Oas30LinkParameterExpression addLinkParameter(String name,
                                                     String expression)

Adds a link parameter expression.

Parameters:

name -

expression -

getLinkParameterExpression

public Oas30LinkParameterExpression getLinkParameterExpression(String name)

Gets a single link parameter expression by name.

Parameters:

name -

removeLinkParameterExpression

public Oas30LinkParameterExpression removeLinkParameterExpression(String name)

Removes a single link parameter expression and returns it. This may return null or undefined if none found.

Parameters:

name -

getLinkParameterExpressions

public List<Oas30LinkParameterExpression> getLinkParameterExpressions()

Gets a list of all link parameter expressions.

createLinkRequestBodyExpression

public Oas30LinkRequestBodyExpression createLinkRequestBodyExpression(String value)

Creates a link request body expression.

Parameters:

value -

createServer

public Oas30LinkServer createServer()

Creates an OAS 3.0 Server object.