ChangeDescriptionCommand (apicurio-data-models 2.2.2 API)

java.lang.Object
- io.apicurio.datamodels.cmd.AbstractCommand
- - io.apicurio.datamodels.cmd.commands.ChangeDescriptionCommand

All Implemented Interfaces:

ICommand
```
public class ChangeDescriptionCommand
extends AbstractCommand
```
A command used to modify the description of a document.

Author:

eric.wittmann@gmail.com

Field Summary

Fields
Modifier and Type Field Description

String _newDescription

boolean _nullInfo

String _oldDescription

Constructor Summary

Constructors
Constructor Description

ChangeDescriptionCommand()
Constructor.

ChangeDescriptionCommand(String newDescription)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`execute(Document document)`	Called to execute the command against the given document.
`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
  - _newDescription
```
public String _newDescription
```
  - _oldDescription
```
public String _oldDescription
```
  - _nullInfo
```
public boolean _nullInfo
```
- Constructor Detail
  - ChangeDescriptionCommand
```
public ChangeDescriptionCommand()
```
    Constructor.
  - ChangeDescriptionCommand
```
public ChangeDescriptionCommand(String newDescription)
```
    Constructor.
    
    Parameters:
    
    newDescription -
- Method Detail
  - execute
```
public void execute(Document document)
```
    Description copied from interface: ICommand
    
    Called to execute the command against the given document.
  - undo
```
public void undo(Document document)
```
    Description copied from interface: ICommand
    
    Called to undo the command (restore the document to a previous state).