Modifier and Type | Method and Description |
---|---|
static Document |
Library.cloneDocument(Document source)
Clones the given document by serializing it to a JS object, and then re-parsing it.
|
static Document |
Library.createDocument(DocumentType type)
Creates a new, empty document of the given type.
|
static Document |
Library.readDocument(Object json)
Reads an entire document from JSON data.
|
static Document |
Library.readDocumentFromJSONString(String jsonString)
Reads an entire document from a JSON formatted string.
|
Modifier and Type | Method and Description |
---|---|
static Document |
Library.cloneDocument(Document source)
Clones the given document by serializing it to a JS object, and then re-parsing it.
|
static String |
Library.writeDocumentToJSONString(Document document)
Called to serialize a given data model to a JSON formatted string.
|
Modifier and Type | Method and Description |
---|---|
void |
AaiDataModelReader.readDocument(Object json,
Document node) |
protected void |
AaiDataModelWriter.writeDocument(Document node,
Object json) |
Modifier and Type | Class and Description |
---|---|
class |
AaiDocument
Models an AsyncAPI root document.
|
Modifier and Type | Class and Description |
---|---|
class |
Aai20Document
Models an AsyncAPI root document.
|
Modifier and Type | Method and Description |
---|---|
protected void |
AaiTraverser.traverseDocument(Document node) |
Modifier and Type | Method and Description |
---|---|
void |
ICommand.execute(Document document)
Called to execute the command against the given document.
|
void |
ICommand.undo(Document document)
Called to undo the command (restore the document to a previous state).
|
Modifier and Type | Method and Description |
---|---|
protected Document |
ReplaceDocumentCommand.readNode(Document doc,
Object node) |
Modifier and Type | Method and Description |
---|---|
protected void |
ReplaceDocumentCommand.addNode(Document doc,
Document node) |
protected void |
ReplaceResponseDefinitionCommand_20.addNode(Document doc,
Oas20ResponseDefinition node) |
protected void |
ReplaceSchemaDefinitionCommand_20.addNode(Document doc,
Oas20SchemaDefinition node) |
protected void |
ReplaceResponseDefinitionCommand_30.addNode(Document doc,
Oas30ResponseDefinition node) |
protected void |
ReplaceSchemaDefinitionCommand_30.addNode(Document doc,
Oas30SchemaDefinition node) |
protected void |
ReplaceOperationCommand.addNode(Document doc,
OasOperation node) |
protected void |
ReplacePathItemCommand.addNode(Document doc,
OasPathItem node) |
protected abstract void |
ReplaceNodeCommand.addNode(Document doc,
T node)
Adds the given node to the data model.
|
static ICommand |
CommandFactory.createReplaceDocumentCommand(Document old,
Document replacement) |
protected void |
ChangeParameterTypeCommand_30.doChangeParameter(Document document,
Parameter parameter) |
protected void |
ChangeParameterTypeCommand_20.doChangeParameter(Document document,
Parameter parameter) |
protected abstract void |
ChangeParameterTypeCommand.doChangeParameter(Document document,
Parameter parameter)
Changes the parameter.
|
protected Object |
DeleteResponseDefinitionCommand_30.doDeleteResponseDefinition(Document document) |
protected Object |
DeleteResponseDefinitionCommand_20.doDeleteResponseDefinition(Document document) |
protected abstract Object |
DeleteResponseDefinitionCommand.doDeleteResponseDefinition(Document document)
Deletes the response definition.
|
protected Object |
DeleteSchemaDefinitionCommand_30.doDeleteSchemaDefinition(Document document) |
protected Object |
DeleteSchemaDefinitionCommand_20.doDeleteSchemaDefinition(Document document) |
protected abstract Object |
DeleteSchemaDefinitionCommand.doDeleteSchemaDefinition(Document document)
Deletes the schema definition.
|
protected Object |
DeleteSecuritySchemeCommand_30.doDeleteScheme(Document document) |
protected Object |
DeleteSecuritySchemeCommand_20.doDeleteScheme(Document document) |
protected abstract Object |
DeleteSecuritySchemeCommand.doDeleteScheme(Document document)
Deletes the scheme.
|
protected void |
DeleteResponseDefinitionCommand_30.doRestoreResponseDefinition(Document document,
Object oldDefinition) |
protected void |
DeleteResponseDefinitionCommand_20.doRestoreResponseDefinition(Document document,
Object oldDefinition) |
protected abstract void |
DeleteResponseDefinitionCommand.doRestoreResponseDefinition(Document document,
Object oldDefinition)
Restores the response definition previously deleted.
|
protected void |
DeleteSchemaDefinitionCommand_30.doRestoreSchemaDefinition(Document document,
Object oldDefinition) |
protected void |
DeleteSchemaDefinitionCommand_20.doRestoreSchemaDefinition(Document document,
Object oldDefinition) |
protected abstract void |
DeleteSchemaDefinitionCommand.doRestoreSchemaDefinition(Document document,
Object oldDefinition)
Restores the schema definition previously deleted.
|
protected void |
DeleteSecuritySchemeCommand_30.doRestoreScheme(Document document,
Object oldScheme) |
protected void |
DeleteSecuritySchemeCommand_20.doRestoreScheme(Document document,
Object oldScheme) |
protected abstract void |
DeleteSecuritySchemeCommand.doRestoreScheme(Document document,
Object oldScheme)
Restores the previously deleted scheme.
|
void |
SetParameterExampleCommand_30.execute(Document document) |
void |
SetExtensionCommand.execute(Document document) |
void |
SetExampleCommand_30.execute(Document document) |
void |
SetExampleCommand_20.execute(Document document) |
void |
ReplaceSecurityRequirementCommand.execute(Document document) |
void |
ReplaceNodeCommand.execute(Document document) |
void |
RenameTagDefinitionCommand.execute(Document document) |
void |
RenameSecuritySchemeCommand.execute(Document document) |
void |
RenameSchemaDefinitionCommand.execute(Document document) |
void |
RenameResponseDefinitionCommand.execute(Document document) |
void |
RenamePropertyCommand.execute(Document document) |
void |
RenamePathItemCommand.execute(Document document) |
void |
RenameParameterCommand.execute(Document document) |
void |
NewTagCommand.execute(Document document) |
void |
NewServerCommand.execute(Document document) |
void |
NewSecuritySchemeCommand_30.execute(Document document) |
void |
NewSecuritySchemeCommand_20.execute(Document document) |
void |
NewSchemaPropertyCommand.execute(Document document) |
void |
NewSchemaDefinitionCommand_30.execute(Document document) |
void |
NewSchemaDefinitionCommand_20.execute(Document document) |
void |
NewResponseDefinitionCommand_30.execute(Document document) |
void |
NewResponseDefinitionCommand_20.execute(Document document) |
void |
NewResponseCommand.execute(Document document) |
void |
NewRequestBodyCommand.execute(Document document) |
void |
NewPathCommand.execute(Document document) |
void |
NewParamCommand.execute(Document document) |
void |
NewOperationCommand.execute(Document document) |
void |
NewMediaTypeCommand.execute(Document document) |
void |
DeleteTagCommand.execute(Document document) |
void |
DeleteServerCommand.execute(Document document) |
void |
DeleteSecuritySchemeCommand.execute(Document document) |
void |
DeleteSecurityRequirementCommand.execute(Document document) |
void |
DeleteSchemaDefinitionCommand.execute(Document document) |
void |
DeleteResponseDefinitionCommand.execute(Document document) |
void |
DeleteResponseCommand.execute(Document document) |
void |
DeletePropertyCommand.execute(Document document) |
void |
DeletePathCommand.execute(Document document) |
void |
DeleteParameterExampleCommand_30.execute(Document document) |
void |
DeleteParameterCommand.execute(Document document) |
void |
DeleteNodeCommand.execute(Document document) |
void |
DeleteMediaTypeCommand.execute(Document document) |
void |
DeleteExtensionCommand.execute(Document document) |
void |
DeleteExampleCommand_30.execute(Document document) |
void |
DeleteExampleCommand_20.execute(Document document) |
void |
DeleteAllTagsCommand.execute(Document document) |
void |
DeleteAllServersCommand.execute(Document document) |
void |
DeleteAllSecuritySchemesCommand.execute(Document document) |
void |
DeleteAllSecurityRequirementsCommand.execute(Document document) |
void |
DeleteAllPropertiesCommand.execute(Document document) |
void |
DeleteAllParametersCommand.execute(Document document) |
void |
DeleteAllParameterExamplesCommand.execute(Document document) |
void |
DeleteAllOperationsCommand.execute(Document document) |
void |
DeleteAllExamplesCommand.execute(Document document) |
void |
ChangeVersionCommand.execute(Document document) |
void |
ChangeTitleCommand.execute(Document document) |
void |
ChangeServerCommand.execute(Document document) |
void |
ChangeSecuritySchemeCommand.execute(Document document) |
void |
ChangeResponseTypeCommand.execute(Document document) |
void |
ChangePropertyTypeCommand.execute(Document document) |
void |
ChangePropertyCommand.execute(Document document) |
void |
ChangeParameterTypeCommand.execute(Document document) |
void |
ChangeMediaTypeTypeCommand.execute(Document document) |
void |
ChangeLicenseCommand.execute(Document document) |
void |
ChangeDescriptionCommand.execute(Document document) |
void |
ChangeContactCommand.execute(Document document) |
void |
AggregateCommand.execute(Document document) |
void |
AddSecurityRequirementCommand.execute(Document document) |
void |
AddSchemaDefinitionCommand.execute(Document document) |
void |
AddResponseDefinitionCommand.execute(Document document) |
void |
AddPathItemCommand.execute(Document document) |
void |
AddParameterExampleCommand_30.execute(Document document) |
void |
AddExampleCommand_30.execute(Document document) |
protected SecurityScheme |
ChangeSecuritySchemeCommand_30.getSchemeFromDocument(Document document) |
protected SecurityScheme |
ChangeSecuritySchemeCommand_20.getSchemeFromDocument(Document document) |
protected abstract SecurityScheme |
ChangeSecuritySchemeCommand.getSchemeFromDocument(Document document)
Gets the scheme from the document.
|
protected Document |
ReplaceDocumentCommand.readNode(Document doc,
Object node) |
protected Oas30SchemaDefinition |
ReplaceSchemaDefinitionCommand_30.readNode(Document doc,
Object node) |
protected Oas20SchemaDefinition |
ReplaceSchemaDefinitionCommand_20.readNode(Document doc,
Object node) |
protected Oas30ResponseDefinition |
ReplaceResponseDefinitionCommand_30.readNode(Document doc,
Object node) |
protected Oas20ResponseDefinition |
ReplaceResponseDefinitionCommand_20.readNode(Document doc,
Object node) |
protected OasPathItem |
ReplacePathItemCommand.readNode(Document doc,
Object node) |
protected OasOperation |
ReplaceOperationCommand.readNode(Document doc,
Object node) |
protected abstract T |
ReplaceNodeCommand.readNode(Document doc,
Object node)
Unmarshalls a node into the appropriate type.
|
protected Oas30RequestBody |
DeleteRequestBodyCommand.readNode(Document doc,
Object node) |
protected Operation |
DeleteOperationCommand.readNode(Document doc,
Object node) |
protected abstract T |
DeleteNodeCommand.readNode(Document doc,
Object node) |
protected License |
DeleteLicenseCommand.readNode(Document doc,
Object node) |
protected Contact |
DeleteContactCommand.readNode(Document doc,
Object node) |
protected OasResponses |
DeleteAllResponsesCommand.readNode(Document doc,
Object node) |
protected void |
ReplaceDocumentCommand.removeNode(Document doc,
Document node) |
protected void |
ReplaceResponseDefinitionCommand_20.removeNode(Document doc,
Oas20ResponseDefinition node) |
protected void |
ReplaceSchemaDefinitionCommand_20.removeNode(Document doc,
Oas20SchemaDefinition node) |
protected void |
ReplaceResponseDefinitionCommand_30.removeNode(Document doc,
Oas30ResponseDefinition node) |
protected void |
ReplaceSchemaDefinitionCommand_30.removeNode(Document doc,
Oas30SchemaDefinition node) |
protected void |
ReplaceOperationCommand.removeNode(Document doc,
OasOperation node) |
protected void |
ReplacePathItemCommand.removeNode(Document doc,
OasPathItem node) |
protected abstract void |
ReplaceNodeCommand.removeNode(Document doc,
T node)
Removes the given node from the data model.
|
void |
SetParameterExampleCommand_30.undo(Document document) |
void |
SetExtensionCommand.undo(Document document) |
void |
SetExampleCommand_30.undo(Document document) |
void |
SetExampleCommand_20.undo(Document document) |
void |
ReplaceSecurityRequirementCommand.undo(Document document) |
void |
ReplaceNodeCommand.undo(Document document) |
void |
RenameTagDefinitionCommand.undo(Document document) |
void |
RenameSecuritySchemeCommand.undo(Document document) |
void |
RenameSchemaDefinitionCommand.undo(Document document) |
void |
RenameResponseDefinitionCommand.undo(Document document) |
void |
RenamePropertyCommand.undo(Document document) |
void |
RenamePathItemCommand.undo(Document document) |
void |
RenameParameterCommand.undo(Document document) |
void |
NewTagCommand.undo(Document document) |
void |
NewServerCommand.undo(Document document) |
void |
NewSecuritySchemeCommand_30.undo(Document document) |
void |
NewSecuritySchemeCommand_20.undo(Document document) |
void |
NewSchemaPropertyCommand.undo(Document document) |
void |
NewSchemaDefinitionCommand_30.undo(Document document) |
void |
NewSchemaDefinitionCommand_20.undo(Document document) |
void |
NewResponseDefinitionCommand_30.undo(Document document) |
void |
NewResponseDefinitionCommand_20.undo(Document document) |
void |
NewResponseCommand.undo(Document document) |
void |
NewRequestBodyCommand.undo(Document document) |
void |
NewPathCommand.undo(Document document) |
void |
NewParamCommand.undo(Document document) |
void |
NewOperationCommand.undo(Document document) |
void |
NewMediaTypeCommand.undo(Document document) |
void |
DeleteTagCommand.undo(Document document) |
void |
DeleteServerCommand.undo(Document document) |
void |
DeleteSecuritySchemeCommand.undo(Document document) |
void |
DeleteSecurityRequirementCommand.undo(Document document) |
void |
DeleteSchemaDefinitionCommand.undo(Document document) |
void |
DeleteResponseDefinitionCommand.undo(Document document) |
void |
DeleteResponseCommand.undo(Document document) |
void |
DeletePropertyCommand.undo(Document document) |
void |
DeletePathCommand.undo(Document document) |
void |
DeleteParameterExampleCommand_30.undo(Document document) |
void |
DeleteParameterCommand.undo(Document document) |
void |
DeleteNodeCommand.undo(Document document) |
void |
DeleteMediaTypeCommand.undo(Document document) |
void |
DeleteExtensionCommand.undo(Document document) |
void |
DeleteExampleCommand_30.undo(Document document) |
void |
DeleteExampleCommand_20.undo(Document document) |
void |
DeleteAllTagsCommand.undo(Document document) |
void |
DeleteAllServersCommand.undo(Document document) |
void |
DeleteAllSecuritySchemesCommand.undo(Document document) |
void |
DeleteAllSecurityRequirementsCommand.undo(Document document) |
void |
DeleteAllPropertiesCommand.undo(Document document) |
void |
DeleteAllParametersCommand.undo(Document document) |
void |
DeleteAllParameterExamplesCommand.undo(Document document) |
void |
DeleteAllOperationsCommand.undo(Document document) |
void |
DeleteAllExamplesCommand.undo(Document document) |
void |
ChangeVersionCommand.undo(Document document) |
void |
ChangeTitleCommand.undo(Document document) |
void |
ChangeServerCommand.undo(Document document) |
void |
ChangeSecuritySchemeCommand.undo(Document document) |
void |
ChangeResponseTypeCommand.undo(Document document) |
void |
ChangePropertyTypeCommand.undo(Document document) |
void |
ChangePropertyCommand.undo(Document document) |
void |
ChangeParameterTypeCommand.undo(Document document) |
void |
ChangeParameterDefinitionTypeCommand_30.undo(Document document) |
void |
ChangeParameterDefinitionTypeCommand_20.undo(Document document) |
void |
ChangeMediaTypeTypeCommand.undo(Document document) |
void |
ChangeLicenseCommand.undo(Document document) |
void |
ChangeDescriptionCommand.undo(Document document) |
void |
ChangeContactCommand.undo(Document document) |
void |
AggregateCommand.undo(Document document) |
void |
AddSecurityRequirementCommand.undo(Document document) |
void |
AddSchemaDefinitionCommand.undo(Document document) |
void |
AddResponseDefinitionCommand.undo(Document document) |
void |
AddPathItemCommand.undo(Document document) |
void |
AddParameterExampleCommand_30.undo(Document document) |
void |
AddExampleCommand_30.undo(Document document) |
Modifier and Type | Method and Description |
---|---|
Document |
OtEngine.getCurrentDocument()
Gets the current document.
|
Modifier and Type | Method and Description |
---|---|
void |
OtCommand.execute(Document document)
Executes the command against the given document.
|
void |
OtCommand.redo(Document document)
Invokes 'redo' on the underlying ICommand but only if it hasn't already been reverted.
|
void |
OtCommand.undo(Document document)
Invokes 'undo' on the underlying ICommand but only if it hasn't already been reverted.
|
Constructor and Description |
---|
OtEngine(Document document)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
CombinedVisitorAdapter.visitDocument(Document node) |
void |
CombinedAllNodeVisitor.visitDocument(Document node) |
void |
CombinedReverseTraverser.visitDocument(Document node) |
void |
CombinedCompositeVisitor.visitDocument(Document node) |
Modifier and Type | Method and Description |
---|---|
static Document |
DocumentFactory.create(DocumentType type) |
Modifier and Type | Method and Description |
---|---|
static ITraverser |
TraverserFactory.create(Document doc,
IVisitor visitor,
TraverserDirection direction)
Create the appropriate traverser for the given document/data model.
|
static DataModelWriter |
VisitorFactory.createDataModelWriter(Document doc) |
static NodePathVisitor |
NodePathVisitorFactory.createNodePathVisitor(Document doc) |
static ValidationProblemsResetVisitor |
VisitorFactory.createValidationProblemsResetVisitor(Document doc) |
static ValidationVisitor |
VisitorFactory.createValidationVisitor(Document doc) |
Modifier and Type | Method and Description |
---|---|
void |
DataModelReader.readDocument(Object json,
Document node)
Reads the root document.
|
void |
DataModelWriter.visitDocument(Document node) |
void |
DataModelReaderDispatcher.visitDocument(Document node) |
protected void |
DataModelWriter.writeDocument(Document node,
Object json)
Writes the document node info into the given json object.
|
Modifier and Type | Field and Description |
---|---|
Document |
Node._ownerDocument |
Modifier and Type | Method and Description |
---|---|
Document |
Node.ownerDocument()
Gets the owner document.
|
Modifier and Type | Method and Description |
---|---|
Node |
NodePath.resolve(Document document)
Resolves a path to its target node within the document model.
|
Node |
NodePath.resolveWithVisitor(Document document,
IVisitor visitor)
Resolves a path to its target node while also visiting all nodes along the way.
|
Modifier and Type | Method and Description |
---|---|
List<ValidationRule> |
ValidationRuleSet.getRulesFor(Document document)
Gets the actual rule instances (visitors) that should be applied to the given document.
|
Constructor and Description |
---|
ValidationVisitor(Document document)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
OasInvalidApiHostRule.visitDocument(Document node) |
void |
OasInvalidApiBasePathRule.visitDocument(Document node) |
Modifier and Type | Method and Description |
---|---|
void |
OasInvalidApiSchemeRule.visitDocument(Document node) |
void |
OasInvalidApiProducesMTRule.visitDocument(Document node) |
void |
OasInvalidApiConsumesMTRule.visitDocument(Document node) |
Modifier and Type | Method and Description |
---|---|
void |
OasMissingOpenApiPropertyRule.visitDocument(Document node) |
void |
OasMissingApiPathsRule.visitDocument(Document node) |
void |
OasMissingApiInformationRule.visitDocument(Document node) |
Modifier and Type | Method and Description |
---|---|
protected void |
Traverser.traverseDocument(Document node)
Subclasses can override this to provide version-specific traversal of the root document.
|
void |
VisitorAdapter.visitDocument(Document node) |
void |
Traverser.visitDocument(Document node) |
void |
NodePathVisitor.visitDocument(Document node) |
void |
IVisitor.visitDocument(Document node) |
void |
ConsumesProducesFinder.visitDocument(Document node) |
void |
CompositeVisitor.visitDocument(Document node) |
void |
AllNodeVisitor.visitDocument(Document node) |
Modifier and Type | Method and Description |
---|---|
void |
OasDataModelReader.readDocument(Object json,
Document node) |
Modifier and Type | Class and Description |
---|---|
class |
OasDocument
Models an OpenAPI document.
|
Modifier and Type | Method and Description |
---|---|
void |
Oas20DataModelReader.readDocument(Object json,
Document node) |
protected void |
Oas20DataModelWriter.writeDocument(Document node,
Object json) |
Modifier and Type | Class and Description |
---|---|
class |
Oas20Document
Models the root document of the OpenAPI 2.0 (aka Swagger) data model.
|
Modifier and Type | Method and Description |
---|---|
protected void |
Oas20Traverser.traverseDocument(Document node) |
Modifier and Type | Method and Description |
---|---|
void |
Oas30DataModelReader.readDocument(Object json,
Document node) |
protected void |
Oas30DataModelWriter.writeDocument(Document node,
Object json) |
Modifier and Type | Class and Description |
---|---|
class |
Oas30Document
Models the root document of the OpenAPI 2.0 (aka Swagger) data model.
|
Modifier and Type | Method and Description |
---|---|
protected void |
Oas30Traverser.traverseDocument(Document node) |
Modifier and Type | Method and Description |
---|---|
protected void |
OasTraverser.traverseDocument(Document node) |
Modifier and Type | Method and Description |
---|---|
void |
Oas20to30TransformationVisitor.visitDocument(Document node) |
Copyright © 2021 Red Hat. All rights reserved.