io.apicurio.datamodels.cmd.commands

Class NewRequestBodyCommand

java.lang.Object

io.apicurio.datamodels.cmd.AbstractCommand

io.apicurio.datamodels.cmd.commands.NewRequestBodyCommand

All Implemented Interfaces:

ICommand

Direct Known Subclasses:

NewRequestBodyCommand_20, NewRequestBodyCommand_30

public abstract class NewRequestBodyCommand
extends AbstractCommand

A command used to create a new request body (parameter of an operation).

Author:

eric.wittmann@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
boolean	_created
NodePath	_operationPath

Method Summary

Modifier and Type	Method and Description
protected abstract void	doCreateRequestBody(OasOperation operation) Creates an empty request body for the given operation.
protected abstract void	doRemoveRequestBody(OasOperation operation) Removes the request body.
void	execute(Document document) Called to execute the command against the given document.
protected abstract boolean	hasRequestBody(OasOperation operation) Returns true if the given operation already has a body parameter.
void	undo(Document document) Called to undo the command (restore the document to a previous state).

Methods inherited from class io.apicurio.datamodels.cmd.AbstractCommand

isNullOrUndefined, type

Methods inherited from class java.lang.Object

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

Field Detail

_operationPath

public NodePath _operationPath

_created

public boolean _created

Method Detail

execute

public void execute(Document document)

Description copied from interface: ICommand

Called to execute the command against the given document.

See Also:

ICommand.execute(io.apicurio.datamodels.core.models.Document)

undo

public void undo(Document document)

Description copied from interface: ICommand

Called to undo the command (restore the document to a previous state).

See Also:

ICommand.undo(io.apicurio.datamodels.core.models.Document)

hasRequestBody

protected abstract boolean hasRequestBody(OasOperation operation)

Returns true if the given operation already has a body parameter.

Parameters:

operation -

doCreateRequestBody

protected abstract void doCreateRequestBody(OasOperation operation)

Creates an empty request body for the given operation.

Parameters:

operation -

doRemoveRequestBody

protected abstract void doRemoveRequestBody(OasOperation operation)

Removes the request body.

Parameters:

operation -