AbstractReplaceNodeCommand (apicurio-data-models 2.2.2 API)

java.lang.Object
- io.apicurio.datamodels.cmd.AbstractCommand
- - io.apicurio.datamodels.cmd.commands.AbstractReplaceNodeCommand<T>

All Implemented Interfaces:

ICommand

Direct Known Subclasses:

ReplaceOperationCommand, ReplacePathItemCommand, ReplaceResponseDefinitionCommand, ReplaceSchemaDefinitionCommand
```
public abstract class AbstractReplaceNodeCommand<T extends Node>
extends AbstractCommand
```
Base class for commands that replace entire nodes.

Author:

eric.wittmann@gmail.com

Field Summary

Fields
Modifier and Type Field Description

com.fasterxml.jackson.databind.node.ObjectNode _new

NodePath _nodePath

com.fasterxml.jackson.databind.node.ObjectNode _old

Constructor Summary

Constructors
Constructor Description

AbstractReplaceNodeCommand()

AbstractReplaceNodeCommand(T old, T replacement)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`execute(Document document)`	Called to execute the command against the given document.
`protected abstract T`	`readNode(Node parent, com.fasterxml.jackson.databind.node.ObjectNode node)`	Unmarshalls a node into the appropriate type.
`protected abstract void`	`replaceNode(Node parent, T newNode)`	Replaces the old node entry with the new node in the data model, without changing the order of the nodes.
`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
indexOf, isNullOrUndefined, type

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_nodePath
```
public NodePath _nodePath
```

_new

public com.fasterxml.jackson.databind.node.ObjectNode _new

_old

public com.fasterxml.jackson.databind.node.ObjectNode _old

Constructor Detail

AbstractReplaceNodeCommand
```
public AbstractReplaceNodeCommand()
```

AbstractReplaceNodeCommand

public AbstractReplaceNodeCommand(T old,
                                  T replacement)

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(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(Document)
- replaceNode
```
protected abstract void replaceNode(Node parent,
                                    T newNode)
```
  Replaces the old node entry with the new node in the data model, without changing the order of the nodes.
- readNode
```
protected abstract T readNode(Node parent,
                              com.fasterxml.jackson.databind.node.ObjectNode node)
```
  Unmarshalls a node into the appropriate type.