swagger-sdk.OpenAPI

Class Document

lucee.Component
    extended by swagger-sdk.OpenAPI.Document

Copyright Ortus Solutions, Corp, All rights reserved www.ortussolutions.com --- Open API Document Object

Class Attributes:
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  
    Property Summary
    type property default serializable required
    any Document


    • access = public
    • returntype = any
    true false
    any jLoader


    • access = public
    • returntype = any
    • inject = loader@cbjavaloader
    true false
    any Wirebox


    • access = public
    • returntype = any
    • inject = wirebox
    true false
    any XPath


    • access = public
    • returntype = any
    true false
    Constructor Summary
    init(struct Doc, string XPath='')
          Constructor.
    Method Summary
    any asJSON()
         Convenience method to return a JSON representation of the normalized document.
    any asStruct()
         Convenience method to return a flattened struct of the Document instance.
    any asYAML()
         Convenience method to return a YAML string of the normalized document.
    private string convertToYAML()
         Converts the entity doc to a YAML string.
    string getDocument()
    string getJLoader()
    any getNormalizedDocument([any APIDoc='[runtime expression]'])
         Normalizes the document recursively to provide a flattened representation.
    string getWirebox()
    string getXPath()
    any locate([string key])
         Helper function to locate deeply nested document items.
    any setDocument(any Document)
    any setJLoader(any jLoader)
    private void setResourceIds(struct resourceDoc, [string hashPrefix=''])
         Sets the resourceId extension of a document path.
    any setWirebox(any Wirebox)
    any setXPath(any XPath)
    private any throwForeignObjectTypeException(any UnKnownObject)
         Throws a foreign object type exception if detected when normalizing a document.
    any xPath(string XPath)
         Convenience methot for setting the XPath of the Document.
    any zoomToXPath()
         Zooms this Document instance to the XPath.
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init(struct Doc, string XPath='')

    Constructor

    Parameters:
    Doc
    XPath

    Property Detail

    Document

    property any Document

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    jLoader

    property any jLoader

    Attributes:
    access - public
    required - false
    returntype - any
    inject - loader@cbjavaloader
    serializable - true

    Wirebox

    property any Wirebox

    Attributes:
    access - public
    required - false
    returntype - any
    inject - wirebox
    serializable - true

    XPath

    property any XPath

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    Method Detail

    asJSON

    public any asJSON()

    Convenience method to return a JSON representation of the normalized document


    asStruct

    public any asStruct()

    Convenience method to return a flattened struct of the Document instance


    asYAML

    public any asYAML()

    Convenience method to return a YAML string of the normalized document


    convertToYAML

    private string convertToYAML()

    Converts the entity doc to a YAML string


    getDocument

    public string getDocument()


    getJLoader

    public string getJLoader()


    getNormalizedDocument

    public any getNormalizedDocument([any APIDoc='[runtime expression]'])

    Normalizes the document recursively to provide a flattened representation

    Parameters:
    APIDoc

    getWirebox

    public string getWirebox()


    getXPath

    public string getXPath()


    locate

    public any locate([string key])

    Helper function to locate deeply nested document items

    Parameters:
    key
    Returns:
    any the value of the key or null if the key is not found

    setDocument

    public any setDocument(any Document)

    Parameters:
    Document

    setJLoader

    public any setJLoader(any jLoader)

    Parameters:
    jLoader

    setResourceIds

    private void setResourceIds(struct resourceDoc, [string hashPrefix=''])

    Sets the resourceId extension of a document path

    Parameters:
    resourceDoc
    hashPrefix

    setWirebox

    public any setWirebox(any Wirebox)

    Parameters:
    Wirebox

    setXPath

    public any setXPath(any XPath)

    Parameters:
    XPath

    throwForeignObjectTypeException

    private any throwForeignObjectTypeException(any UnKnownObject)

    Throws a foreign object type exception if detected when normalizing a document

    Parameters:
    UnKnownObject

    xPath

    public any xPath(string XPath)

    Convenience methot for setting the XPath of the Document

    Parameters:
    XPath

    zoomToXPath

    public any zoomToXPath()

    Zooms this Document instance to the XPath