Packages

class AsyncWebApiDeclarations extends OasLikeWebApiDeclarations

Linear Supertypes
OasLikeWebApiDeclarations, WebApiDeclarations, ShapeDeclarations, Declarations, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AsyncWebApiDeclarations
  2. OasLikeWebApiDeclarations
  3. WebApiDeclarations
  4. ShapeDeclarations
  5. Declarations
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AsyncWebApiDeclarations(asts: Map[String, YNode], alias: Option[String], errorHandler: AMFErrorHandler, futureDeclarations: FutureDeclarations)

Type Members

  1. trait ErrorDeclaration extends AnyRef
    Definition Classes
    Declarations
  2. type Identity[T] = T
    Definition Classes
    Declarations

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from AsyncWebApiDeclarations to any2stringadd[AsyncWebApiDeclarations] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def +=(indexKey: String, element: DomainElement): AsyncWebApiDeclarations.this.type
    Definition Classes
    WebApiDeclarations → ShapeDeclarations → Declarations
  5. def +=(element: DomainElement): AsyncWebApiDeclarations.this.type
    Definition Classes
    WebApiDeclarations → Declarations
  6. def +=(doc: (String, (Shape, Map[String, Shape]))): AsyncWebApiDeclarations.this.type
    Definition Classes
    ShapeDeclarations
  7. def +=(extension: Map[String, Dialect]): ShapeDeclarations
    Definition Classes
    ShapeDeclarations
  8. def +=(indexKey: String, fragment: Fragment): Declarations
    Definition Classes
    Declarations
  9. def ->[B](y: B): (AsyncWebApiDeclarations, B)
    Implicit
    This member is added by an implicit conversion from AsyncWebApiDeclarations to ArrowAssoc[AsyncWebApiDeclarations] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  10. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def addLibrary(alias: String, declarations: Declarations): Unit
    Definition Classes
    WebApiDeclarations → Declarations
  12. def addSchema(indexKey: String, s: Shape): Unit
    Attributes
    protected
    Definition Classes
    ShapeDeclarations
  13. val alias: Option[String]
    Definition Classes
    AsyncWebApiDeclarations → OasLikeWebApiDeclarations → ShapeDeclarations
  14. def aliased(name: String): String
    Definition Classes
    ShapeDeclarations
  15. var annotations: Map[String, CustomDomainProperty]
    Definition Classes
    Declarations
  16. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  17. val asts: Map[String, YNode]
    Definition Classes
    AsyncWebApiDeclarations → OasLikeWebApiDeclarations
  18. var avroDocumentFragmentAliases: Set[String]
    Definition Classes
    WebApiDeclarations
  19. var callbacks: Map[String, List[Callback]]
    Definition Classes
    WebApiDeclarations
  20. var channelBindings: Map[String, ChannelBindings]
    Definition Classes
    WebApiDeclarations
  21. var channels: Map[String, EndPoint]
    Definition Classes
    WebApiDeclarations
  22. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  23. var componentExternalDocs: Map[String, CreativeWork]
    Definition Classes
    WebApiDeclarations
  24. var componentTags: Map[String, Tag]
    Definition Classes
    WebApiDeclarations
  25. var concreteOperations: Map[String, Operation]
    Definition Classes
    WebApiDeclarations
  26. def copy(): WebApiDeclarations
    Definition Classes
    WebApiDeclarations → ShapeDeclarations
  27. def copy[T <: ShapeDeclarations](next: T): T
    Definition Classes
    ShapeDeclarations
  28. var correlationIds: Map[String, CorrelationId]
    Definition Classes
    WebApiDeclarations
  29. def declarables(): Seq[DomainElement]
    Definition Classes
    WebApiDeclarations → Declarations
  30. var documentFragments: Map[String, (Shape, Map[String, Shape])]
    Definition Classes
    ShapeDeclarations
  31. def ensuring(cond: (AsyncWebApiDeclarations) ⇒ Boolean, msg: ⇒ Any): AsyncWebApiDeclarations
    Implicit
    This member is added by an implicit conversion from AsyncWebApiDeclarations to Ensuring[AsyncWebApiDeclarations] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  32. def ensuring(cond: (AsyncWebApiDeclarations) ⇒ Boolean): AsyncWebApiDeclarations
    Implicit
    This member is added by an implicit conversion from AsyncWebApiDeclarations to Ensuring[AsyncWebApiDeclarations] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  33. def ensuring(cond: Boolean, msg: ⇒ Any): AsyncWebApiDeclarations
    Implicit
    This member is added by an implicit conversion from AsyncWebApiDeclarations to Ensuring[AsyncWebApiDeclarations] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  34. def ensuring(cond: Boolean): AsyncWebApiDeclarations
    Implicit
    This member is added by an implicit conversion from AsyncWebApiDeclarations to Ensuring[AsyncWebApiDeclarations] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  35. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  37. def error(message: String, pos: SourceLocation): Unit
    Attributes
    protected
    Definition Classes
    Declarations
  38. val errorHandler: AMFErrorHandler
    Definition Classes
    AsyncWebApiDeclarations → OasLikeWebApiDeclarations → WebApiDeclarations
  39. var examples: Map[String, Example]
    Definition Classes
    ShapeDeclarations
  40. var extensions: Map[String, Dialect]
    Definition Classes
    ShapeDeclarations
  41. var externalLibs: Map[String, Map[String, AnyShape]]
    Definition Classes
    ShapeDeclarations
  42. var externalShapes: Map[String, AnyShape]
    Definition Classes
    ShapeDeclarations
  43. val extractor: QualifiedNameExtractor
    Definition Classes
    OasLikeWebApiDeclarations → WebApiDeclarations
  44. def findAnnotation(key: String, scope: Scope): Option[CustomDomainProperty]
    Definition Classes
    Declarations
  45. def findAnnotationOrError(pos: SourceLocation)(key: String, scope: Scope): CustomDomainProperty
    Definition Classes
    Declarations
  46. def findCallbackInDeclarations(key: String, scope: Scope = Named): Option[List[Callback]]
    Definition Classes
    WebApiDeclarations
  47. def findChannel(key: String, scope: Scope): Option[EndPoint]
    Definition Classes
    WebApiDeclarations
  48. def findChannelBindings(key: String, scope: Scope): Option[ChannelBindings]
    Definition Classes
    WebApiDeclarations
  49. def findComponentExternalDocs(key: String, scope: Scope): Option[CreativeWork]

    Find an externalDocs declared under AsyncAPI 3.0 components.externalDocs.

    Find an externalDocs declared under AsyncAPI 3.0 components.externalDocs.

    Definition Classes
    WebApiDeclarations
  50. def findComponentTag(key: String, scope: Scope): Option[Tag]

    Find a tag declared under AsyncAPI 3.0 components.tags.

    Find a tag declared under AsyncAPI 3.0 components.tags.

    Definition Classes
    WebApiDeclarations
  51. def findCorrelationId(key: String, scope: Scope): Option[CorrelationId]
    Definition Classes
    WebApiDeclarations
  52. def findDeclaredTypeInDocFragment(doc: String, name: String): Option[Shape]
    Definition Classes
    ShapeDeclarations
  53. def findDialect(key: String): Option[Dialect]
    Definition Classes
    WebApiDeclarations
  54. def findDocumentations(key: String, scope: Scope, error: Option[(String) ⇒ Unit]): Option[CreativeWork]
    Definition Classes
    ShapeDeclarations
  55. def findEncodedTypeInDocFragment(doc: String): Option[Shape]
    Definition Classes
    ShapeDeclarations
  56. def findEquivalent(element: DomainElement): Option[DomainElement]

    Find domain element with the same name.

    Find domain element with the same name.

    Definition Classes
    WebApiDeclarations → Declarations
  57. def findExample(key: String, scope: Scope): Option[Example]
    Definition Classes
    ShapeDeclarations
  58. def findForType(key: String, map: (Declarations) ⇒ Map[String, DomainElement], scope: Scope): Option[DomainElement]
    Definition Classes
    Declarations
  59. def findHeader(key: String, scope: Scope): Option[Parameter]
    Definition Classes
    WebApiDeclarations
  60. def findInExternals(url: String): Option[AnyShape]
    Definition Classes
    ShapeDeclarations
  61. def findInExternalsLibs(lib: String, name: String): Option[AnyShape]
    Definition Classes
    ShapeDeclarations
  62. def findManyForType(key: String, map: (Declarations) ⇒ Map[String, List[DomainElement]], scope: Scope): Option[List[DomainElement]]
    Definition Classes
    Declarations
  63. def findMessage(key: String, scope: Scope): Option[Message]
    Definition Classes
    WebApiDeclarations
  64. def findMessageBindings(key: String, scope: Scope): Option[MessageBindings]
    Definition Classes
    WebApiDeclarations
  65. def findMessageTrait(key: String, scope: Scope): Option[Message]
    Definition Classes
    WebApiDeclarations
  66. def findNamedExample(key: String, error: Option[(String) ⇒ Unit]): Option[Example]
    Definition Classes
    ShapeDeclarations
  67. def findNamedExampleOrError(ast: YPart)(key: String): Example
    Definition Classes
    ShapeDeclarations
  68. def findOperation(key: String, scope: Scope): Option[Operation]

    Find a concrete operation declared under AsyncAPI 3.0 components.operations.

    Find a concrete operation declared under AsyncAPI 3.0 components.operations. Distinct from operation traits (operationTraits); concrete operations are not abstract.

    Definition Classes
    WebApiDeclarations
  69. def findOperationBindings(key: String, scope: Scope): Option[OperationBindings]
    Definition Classes
    WebApiDeclarations
  70. def findOperationTrait(key: String, scope: Scope): Option[Operation]
    Definition Classes
    WebApiDeclarations
  71. def findParameter(key: String, scope: Scope): Option[Parameter]
    Definition Classes
    WebApiDeclarations
  72. def findParameterOrError(ast: YPart)(key: String, scope: Scope): Parameter
    Definition Classes
    WebApiDeclarations
  73. def findPayload(key: String, scope: Scope): Option[Payload]
    Definition Classes
    WebApiDeclarations
  74. def findReply(key: String, scope: Scope): Option[OperationReply]
    Definition Classes
    WebApiDeclarations
  75. def findReplyAddress(key: String, scope: Scope): Option[OperationReplyAddress]
    Definition Classes
    WebApiDeclarations
  76. def findRequestBody(key: String, scope: Scope): Option[Request]
    Definition Classes
    WebApiDeclarations
  77. def findResourceType(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[ResourceType]
    Definition Classes
    WebApiDeclarations
  78. def findResourceTypeOrError(ast: YPart)(key: String, scope: Scope): ResourceType
    Definition Classes
    WebApiDeclarations
  79. def findResponse(key: String, scope: Scope): Option[Response]
    Definition Classes
    WebApiDeclarations
  80. def findResponseOrError(ast: YPart)(key: String, searchScope: Scope): Response
    Definition Classes
    WebApiDeclarations
  81. def findSecurityScheme(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[SecurityScheme]
    Definition Classes
    WebApiDeclarations
  82. def findSecuritySchemeOrError(ast: YPart)(key: String, scope: Scope): SecurityScheme
    Definition Classes
    WebApiDeclarations
  83. def findServer(key: String, scope: Scope): Option[Server]
    Definition Classes
    WebApiDeclarations
  84. def findServerBindings(key: String, scope: Scope): Option[ServerBindings]
    Definition Classes
    WebApiDeclarations
  85. def findServerVariable(key: String, scope: Scope): Option[Parameter]
    Definition Classes
    WebApiDeclarations
  86. def findTemplatedLink(key: String, scope: Scope): Option[TemplatedLink]
    Definition Classes
    WebApiDeclarations
  87. def findTraitOrError(ast: YPart)(key: String, scope: Scope): Trait
    Definition Classes
    WebApiDeclarations
  88. def findType(key: String, scope: Scope, error: Option[(String) ⇒ Unit]): Option[AnyShape]
    Definition Classes
    ShapeDeclarations
  89. var fragments: Map[String, FragmentRef]
    Definition Classes
    Declarations
  90. val futureDeclarations: FutureDeclarations
    Definition Classes
    AsyncWebApiDeclarations → OasLikeWebApiDeclarations → WebApiDeclarations
  91. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  92. def getOrCreateLibrary(alias: String): WebApiDeclarations

    Get or create specified library.

    Get or create specified library.

    Definition Classes
    WebApiDeclarations → Declarations
  93. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  94. var headers: Map[String, Parameter]
    Definition Classes
    WebApiDeclarations
  95. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  96. var libraries: Map[String, Declarations]
    Definition Classes
    Declarations
  97. var links: Map[String, TemplatedLink]
    Definition Classes
    WebApiDeclarations
  98. def merge(other: WebApiDeclarations): WebApiDeclarations
    Definition Classes
    WebApiDeclarations
  99. def mergeParts(other: WebApiDeclarations, merged: WebApiDeclarations): Unit
    Attributes
    protected
    Definition Classes
    WebApiDeclarations
  100. var messageBindings: Map[String, MessageBindings]
    Definition Classes
    WebApiDeclarations
  101. var messageTraits: Map[String, Message]
    Definition Classes
    WebApiDeclarations
  102. var messages: Map[String, Message]
    Definition Classes
    WebApiDeclarations
  103. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  104. def nonEmpty: Boolean
    Definition Classes
    WebApiDeclarations
  105. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  106. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  107. var operationBindings: Map[String, OperationBindings]
    Definition Classes
    WebApiDeclarations
  108. var operationTraits: Map[String, Operation]
    Definition Classes
    WebApiDeclarations
  109. var others: Map[String, BaseUnit]
    Definition Classes
    WebApiDeclarations
  110. def parameterPayload(parameter: Parameter): Payload
    Definition Classes
    WebApiDeclarations
  111. var parameters: Map[String, Parameter]
    Definition Classes
    WebApiDeclarations
  112. var payloads: Map[String, Payload]
    Definition Classes
    WebApiDeclarations
  113. def promoteExternalToDataTypeFragment(text: String, fullRef: String, shape: Shape): Unit
    Definition Classes
    ShapeDeclarations
  114. var promotedFragments: Seq[Fragment]
    Definition Classes
    Declarations
  115. def registerExternalLib(url: String, content: Map[String, AnyShape]): ShapeDeclarations
    Definition Classes
    ShapeDeclarations
  116. def registerExternalRef(external: (String, AnyShape)): ShapeDeclarations
    Definition Classes
    ShapeDeclarations
  117. def registerHeader(header: Parameter): Unit
    Definition Classes
    WebApiDeclarations
  118. def registerOasParameter(oasParameter: OasParameter): Unit
    Definition Classes
    WebApiDeclarations
  119. var replies: Map[String, OperationReply]
    Definition Classes
    WebApiDeclarations
  120. var replyAddresses: Map[String, OperationReplyAddress]
    Definition Classes
    WebApiDeclarations
  121. var requests: Map[String, Request]
    Definition Classes
    WebApiDeclarations
  122. var resourceTypes: Map[String, ResourceType]
    Definition Classes
    WebApiDeclarations
  123. var responses: Map[String, Response]
    Definition Classes
    WebApiDeclarations
  124. var securitySchemes: Map[String, SecurityScheme]
    Definition Classes
    WebApiDeclarations
  125. var serverBindings: Map[String, ServerBindings]
    Definition Classes
    WebApiDeclarations
  126. var serverVariables: Map[String, Parameter]
    Definition Classes
    WebApiDeclarations
  127. var servers: Map[String, Server]
    Definition Classes
    WebApiDeclarations
  128. def setLibraries(libraries: Map[String, Declarations]): Unit
    Definition Classes
    WebApiDeclarations
  129. var shapes: Map[String, Shape]
    Definition Classes
    ShapeDeclarations
  130. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  131. def toString(): String
    Definition Classes
    AnyRef → Any
  132. var traits: Map[String, Trait]
    Definition Classes
    WebApiDeclarations
  133. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  134. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  135. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  136. def withExtensions(extensions: Map[String, Dialect]): ShapeDeclarations
    Definition Classes
    ShapeDeclarations
  137. def →[B](y: B): (AsyncWebApiDeclarations, B)
    Implicit
    This member is added by an implicit conversion from AsyncWebApiDeclarations to ArrowAssoc[AsyncWebApiDeclarations] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from AsyncWebApiDeclarations to StringFormat[AsyncWebApiDeclarations] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

Inherited from OasLikeWebApiDeclarations

Inherited from WebApiDeclarations

Inherited from ShapeDeclarations

Inherited from Declarations

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from AsyncWebApiDeclarations to any2stringadd[AsyncWebApiDeclarations]

Inherited by implicit conversion StringFormat from AsyncWebApiDeclarations to StringFormat[AsyncWebApiDeclarations]

Inherited by implicit conversion Ensuring from AsyncWebApiDeclarations to Ensuring[AsyncWebApiDeclarations]

Inherited by implicit conversion ArrowAssoc from AsyncWebApiDeclarations to ArrowAssoc[AsyncWebApiDeclarations]

Ungrouped