Packages

class WebApiDeclarations extends ShapeDeclarations

Declarations object.

Linear Supertypes
ShapeDeclarations, Declarations, AnyRef, Any
Known Subclasses
AsyncWebApiDeclarations, AwsOasWebApiDeclarations, ExtensionWebApiDeclarations, JsonSchemaDeclarations, OasLikeWebApiDeclarations, OasWebApiDeclarations, RamlWebApiDeclarations
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WebApiDeclarations
  2. ShapeDeclarations
  3. Declarations
  4. AnyRef
  5. 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 WebApiDeclarations(alias: Option[String], errorHandler: AMFErrorHandler, futureDeclarations: FutureDeclarations, extractor: QualifiedNameExtractor)

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 WebApiDeclarations to any2stringadd[WebApiDeclarations] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def +=(indexKey: String, element: DomainElement): WebApiDeclarations.this.type
    Definition Classes
    WebApiDeclarations → ShapeDeclarations → Declarations
  5. def +=(element: DomainElement): WebApiDeclarations.this.type
    Definition Classes
    WebApiDeclarations → Declarations
  6. def +=(doc: (String, (Shape, Map[String, Shape]))): WebApiDeclarations.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): (WebApiDeclarations, B)
    Implicit
    This member is added by an implicit conversion from WebApiDeclarations to ArrowAssoc[WebApiDeclarations] 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
    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. var avroDocumentFragmentAliases: Set[String]
  18. var callbacks: Map[String, List[Callback]]
  19. var channelBindings: Map[String, ChannelBindings]
  20. var channels: Map[String, EndPoint]
  21. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  22. var componentExternalDocs: Map[String, CreativeWork]
  23. var componentTags: Map[String, Tag]
  24. var concreteOperations: Map[String, Operation]
  25. def copy(): WebApiDeclarations
    Definition Classes
    WebApiDeclarations → ShapeDeclarations
  26. def copy[T <: ShapeDeclarations](next: T): T
    Definition Classes
    ShapeDeclarations
  27. var correlationIds: Map[String, CorrelationId]
  28. def declarables(): Seq[DomainElement]
    Definition Classes
    WebApiDeclarations → Declarations
  29. var documentFragments: Map[String, (Shape, Map[String, Shape])]
    Definition Classes
    ShapeDeclarations
  30. def ensuring(cond: (WebApiDeclarations) ⇒ Boolean, msg: ⇒ Any): WebApiDeclarations
    Implicit
    This member is added by an implicit conversion from WebApiDeclarations to Ensuring[WebApiDeclarations] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  31. def ensuring(cond: (WebApiDeclarations) ⇒ Boolean): WebApiDeclarations
    Implicit
    This member is added by an implicit conversion from WebApiDeclarations to Ensuring[WebApiDeclarations] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  32. def ensuring(cond: Boolean, msg: ⇒ Any): WebApiDeclarations
    Implicit
    This member is added by an implicit conversion from WebApiDeclarations to Ensuring[WebApiDeclarations] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  33. def ensuring(cond: Boolean): WebApiDeclarations
    Implicit
    This member is added by an implicit conversion from WebApiDeclarations to Ensuring[WebApiDeclarations] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  34. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  36. def error(message: String, pos: SourceLocation): Unit
    Attributes
    protected
    Definition Classes
    Declarations
  37. val errorHandler: AMFErrorHandler
  38. var examples: Map[String, Example]
    Definition Classes
    ShapeDeclarations
  39. var extensions: Map[String, Dialect]
    Definition Classes
    ShapeDeclarations
  40. var externalLibs: Map[String, Map[String, AnyShape]]
    Definition Classes
    ShapeDeclarations
  41. var externalShapes: Map[String, AnyShape]
    Definition Classes
    ShapeDeclarations
  42. val extractor: QualifiedNameExtractor
  43. def findAnnotation(key: String, scope: Scope): Option[CustomDomainProperty]
    Definition Classes
    Declarations
  44. def findAnnotationOrError(pos: SourceLocation)(key: String, scope: Scope): CustomDomainProperty
    Definition Classes
    Declarations
  45. def findCallbackInDeclarations(key: String, scope: Scope = Named): Option[List[Callback]]
  46. def findChannel(key: String, scope: Scope): Option[EndPoint]
  47. def findChannelBindings(key: String, scope: Scope): Option[ChannelBindings]
  48. def findComponentExternalDocs(key: String, scope: Scope): Option[CreativeWork]

    Find an externalDocs declared under AsyncAPI 3.0 components.externalDocs.

  49. def findComponentTag(key: String, scope: Scope): Option[Tag]

    Find a tag declared under AsyncAPI 3.0 components.tags.

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

    Find domain element with the same name.

    Find domain element with the same name.

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

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

    Get or create specified library.

    Get or create specified library.

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

Inherited from Declarations

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped