io.apicurio.datamodels.core.io

Class DataModelWriter

java.lang.Object

io.apicurio.datamodels.core.io.DataModelWriter

All Implemented Interfaces:

IVisitor

Direct Known Subclasses:

AaiDataModelWriter, OasDataModelWriter

public class DataModelWriter
extends Object
implements IVisitor

Base class for all data model writers.

Author:

eric.wittmann@gmail.com

Constructor Summary

Constructors

Constructor and Description
DataModelWriter() Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addParameterDefinitionToParent(Object parent, Object json, IDefinition node)
protected void	addSchemaDefinitionToParent(Object parent, Object json, IDefinition node)
protected void	addSecuritySchemeToParent(Object parent, Object json, SecurityScheme node)
protected void	doVisitSchema(Schema node, String parentPropertyName, boolean isCollection)
Object	getResult() Gets the result of the writing.
protected Object	lookup(int modelId, Object jsonDefault) Lookup the parent node via modelId if it exists (we already processed it).
protected Object	lookupParentJson(Node node) Lookup a JS object using the model ID of the node's parent.
protected Object	lookupParentJson(Node node, Object jsonDefault)
protected void	updateIndex(Node node, Object json)
void	visitContact(Contact node)
void	visitDocument(Document node)
void	visitExtension(Extension node)
void	visitExternalDocumentation(ExternalDocumentation node)
void	visitInfo(Info node)
void	visitLicense(License node)
void	visitOperation(Operation node)
void	visitParameter(Parameter node)
void	visitParameterDefinition(IDefinition node)
void	visitSchema(Schema node)
void	visitSchemaDefinition(IDefinition node)
void	visitSecurityRequirement(SecurityRequirement node)
void	visitSecurityScheme(SecurityScheme node)
void	visitTag(Tag node)
void	visitValidationProblem(ValidationProblem problem)
protected void	writeDocument(Document node, Object json) Writes the document node info into the given json object.
protected void	writeExtraProperties(Object json, Node node)
protected void	writeOperation(Object json, Operation node)
protected void	writeParameter(Object json, Parameter node)
protected void	writeSchema(Object json, Schema node)
protected void	writeSecurityScheme(Object json, SecurityScheme node)

Methods inherited from class java.lang.Object

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

Constructor Detail

DataModelWriter

public DataModelWriter()

Constructor.

Method Detail

getResult

public Object getResult()

Gets the result of the writing.

updateIndex

protected void updateIndex(Node node,
                           Object json)

writeExtraProperties

protected void writeExtraProperties(Object json,
                                    Node node)

lookup

protected Object lookup(int modelId,
                        Object jsonDefault)

Lookup the parent node via modelId if it exists (we already processed it). Caller must provide the parent object as a second argument for cases when it does not exist.

Parameters:

modelId -

jsonDefault - not null

lookupParentJson

protected Object lookupParentJson(Node node)

Lookup a JS object using the model ID of the node's parent.

Parameters:

node -

lookupParentJson

protected Object lookupParentJson(Node node,
                                  Object jsonDefault)

visitDocument

public void visitDocument(Document node)

Specified by:

visitDocument in interface IVisitor

See Also:

IVisitor.visitDocument(io.apicurio.datamodels.core.models.Document)

writeDocument

protected void writeDocument(Document node,
                             Object json)

Writes the document node info into the given json object.

Parameters:

node -

json -

visitExtension

public void visitExtension(Extension node)

Specified by:

visitExtension in interface IVisitor

See Also:

IVisitor.visitExtension(io.apicurio.datamodels.core.models.Extension)

visitInfo

public void visitInfo(Info node)

Specified by:

visitInfo in interface IVisitor

See Also:

IVisitor.visitInfo(io.apicurio.datamodels.core.models.common.Info)

visitContact

public void visitContact(Contact node)

Specified by:

visitContact in interface IVisitor

See Also:

IVisitor.visitContact(io.apicurio.datamodels.core.models.common.Contact)

visitLicense

public void visitLicense(License node)

Specified by:

visitLicense in interface IVisitor

See Also:

IVisitor.visitLicense(io.apicurio.datamodels.core.models.common.License)

visitTag

public void visitTag(Tag node)

Specified by:

visitTag in interface IVisitor

See Also:

IVisitor.visitTag(io.apicurio.datamodels.core.models.common.Tag)

visitSecurityRequirement

public void visitSecurityRequirement(SecurityRequirement node)

Specified by:

visitSecurityRequirement in interface IVisitor

See Also:

IVisitor.visitSecurityRequirement(io.apicurio.datamodels.core.models.common.SecurityRequirement)

visitExternalDocumentation

public void visitExternalDocumentation(ExternalDocumentation node)

Specified by:

visitExternalDocumentation in interface IVisitor

See Also:

IVisitor.visitExternalDocumentation(io.apicurio.datamodels.core.models.common.ExternalDocumentation)

visitOperation

public void visitOperation(Operation node)

Specified by:

visitOperation in interface IVisitor

See Also:

IVisitor.visitOperation(io.apicurio.datamodels.core.models.common.Operation)

writeOperation

protected void writeOperation(Object json,
                              Operation node)

visitParameter

public void visitParameter(Parameter node)

Specified by:

visitParameter in interface IVisitor

See Also:

IVisitor.visitParameter(io.apicurio.datamodels.core.models.common.Parameter)

writeParameter

protected void writeParameter(Object json,
                              Parameter node)

visitSchema

public void visitSchema(Schema node)

Specified by:

visitSchema in interface IVisitor

See Also:

IVisitor.visitSchema(io.apicurio.datamodels.core.models.common.Schema)

doVisitSchema

protected void doVisitSchema(Schema node,
                             String parentPropertyName,
                             boolean isCollection)

writeSchema

protected void writeSchema(Object json,
                           Schema node)

visitValidationProblem

public void visitValidationProblem(ValidationProblem problem)

Specified by:

visitValidationProblem in interface IVisitor

See Also:

IVisitor.visitValidationProblem(io.apicurio.datamodels.core.models.ValidationProblem)

visitSecurityScheme

public void visitSecurityScheme(SecurityScheme node)

Specified by:

visitSecurityScheme in interface IVisitor

See Also:

IVisitor.visitSecurityScheme(io.apicurio.datamodels.core.models.common.SecurityScheme)

writeSecurityScheme

protected void writeSecurityScheme(Object json,
                                   SecurityScheme node)

addSecuritySchemeToParent

protected void addSecuritySchemeToParent(Object parent,
                                         Object json,
                                         SecurityScheme node)

visitSchemaDefinition

public void visitSchemaDefinition(IDefinition node)

Specified by:

visitSchemaDefinition in interface IVisitor

See Also:

IVisitor.visitSchemaDefinition(io.apicurio.datamodels.core.models.common.IDefinition)

addSchemaDefinitionToParent

protected void addSchemaDefinitionToParent(Object parent,
                                           Object json,
                                           IDefinition node)

visitParameterDefinition

public void visitParameterDefinition(IDefinition node)

Specified by:

visitParameterDefinition in interface IVisitor

See Also:

IVisitor.visitParameterDefinition(io.apicurio.datamodels.core.models.common.IDefinition)

addParameterDefinitionToParent

protected void addParameterDefinitionToParent(Object parent,
                                              Object json,
                                              IDefinition node)