Package io.apicurio.datamodels.deref

Class ReferencedNodeImporter

java.lang.Object

io.apicurio.datamodels.models.visitors.CombinedVisitorAdapter

io.apicurio.datamodels.deref.ReferencedNodeImporter

All Implemented Interfaces:

AsyncApi20Visitor, AsyncApi21Visitor, AsyncApi22Visitor, AsyncApi23Visitor, AsyncApi24Visitor, AsyncApi25Visitor, AsyncApi26Visitor, AsyncApi30Visitor, AsyncApiVisitor, OpenApi20Visitor, OpenApi30Visitor, OpenApi31Visitor, OpenApiVisitor, Visitor

Direct Known Subclasses:

AsyncApi2NodeImporter, AsyncApi3NodeImporter, OpenApi2NodeImporter, OpenApi3NodeImporter

public abstract class ReferencedNodeImporter
extends CombinedVisitorAdapter

Constructor Summary

Constructors

Constructor	Description
ReferencedNodeImporter(Document doc, Node nodeWithUnresolvedRef, String ref, boolean shouldInline)

Method Summary

Modifier and Type	Method	Description
protected String	generateNodeName(String nameHint, Collection<String> existingNames)
protected String	getComponentName(Node nodeWithUnresolvedRef)
protected Collection<String>	getComponentNames(Map<String,?> components)
protected Document	getDoc()
Node	getImportedNode()
String	getNameHintFromRef(String defaultHint)
protected Node	getNodeWithUnresolvedRef()
String	getPathToImportedNode()
protected String	getRef()
void	importJson(com.fasterxml.jackson.databind.JsonNode jsonNode, String mediaType)	Imports a JsonNode (JSON/YAML content that is not OpenAPI/AsyncAPI).
void	importNode(Node resolvedNode)
void	importText(String textContent, String mediaType)	Imports text content (non-JSON content such as Protocol Buffers, GraphQL, etc.).
protected void	inlineComponent(String componentType, Node node)
void	setPathToImportedNode(Node importedNode, String pathToImportedNode)
protected abstract void	setPathToImportedNode(Node nodeWithUnresolvedRef, String componentType, String componentName)
boolean	shouldInline()

Methods inherited from class io.apicurio.datamodels.models.visitors.CombinedVisitorAdapter

visitBinding, visitCallback, visitChannel, visitChannelBindings, visitChannelItem, visitChannels, visitComponents, visitContact, visitCorrelationID, visitDefinitions, visitDiscriminator, visitDocument, visitEncoding, visitExample, visitExternalDocumentation, visitHeader, visitInfo, visitItems, visitLicense, visitLink, visitMediaType, visitMessage, visitMessageBindings, visitMessageExample, visitMessageTrait, visitMultiFormatSchema, visitOAuthFlow, visitOAuthFlows, visitOneOfMessages, visitOperation, visitOperationBindings, visitOperationReply, visitOperationReplyAddress, visitOperations, visitOperationTrait, visitParameter, visitParameterDefinitions, visitParameters, visitPathItem, visitPaths, visitReference, visitRequestBody, visitResponse, visitResponseDefinitions, visitResponses, visitSchema, visitScopes, visitSecurityDefinitions, visitSecurityRequirement, visitSecurityScheme, visitServer, visitServerBindings, visitServers, visitServerVariable, visitTag, visitXML

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferencedNodeImporter

public ReferencedNodeImporter(Document doc,
                              Node nodeWithUnresolvedRef,
                              String ref,
                              boolean shouldInline)

Method Detail

getImportedNode

public Node getImportedNode()

getPathToImportedNode

public String getPathToImportedNode()

getDoc

protected Document getDoc()

getNodeWithUnresolvedRef

protected Node getNodeWithUnresolvedRef()

getRef

protected String getRef()

shouldInline

public boolean shouldInline()

getNameHintFromRef

public String getNameHintFromRef(String defaultHint)

importNode

public void importNode(Node resolvedNode)

importJson

public void importJson(com.fasterxml.jackson.databind.JsonNode jsonNode,
                       String mediaType)

Imports a JsonNode (JSON/YAML content that is not OpenAPI/AsyncAPI). Subclasses should override this method to handle JSON content appropriately. The default implementation throws an UnsupportedOperationException.

Parameters:

jsonNode - the JsonNode to import

mediaType - the media type of the content (may be null)

importText

public void importText(String textContent,
                       String mediaType)

Imports text content (non-JSON content such as Protocol Buffers, GraphQL, etc.). Subclasses should override this method to handle text content appropriately. The default implementation throws an UnsupportedOperationException.

Parameters:

textContent - the text content to import

mediaType - the media type of the content (may be null)

setPathToImportedNode

public void setPathToImportedNode(Node importedNode,
                                  String pathToImportedNode)

generateNodeName

protected String generateNodeName(String nameHint,
                                  Collection<String> existingNames)

getComponentNames

protected Collection<String> getComponentNames(Map<String,?> components)

getComponentName

protected String getComponentName(Node nodeWithUnresolvedRef)

inlineComponent

protected void inlineComponent(String componentType,
                               Node node)

setPathToImportedNode

protected abstract void setPathToImportedNode(Node nodeWithUnresolvedRef,
                                              String componentType,
                                              String componentName)