Packages

class RamlWebApiDeclarations extends WebApiDeclarations

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

    Find domain element with the same name.

    Find domain element with the same name.

    Definition Classes
    WebApiDeclarations → Declarations
  52. def findExample(key: String, scope: Scope): Option[Example]
    Definition Classes
    ShapeDeclarations
  53. def findForType(key: String, map: (Declarations) ⇒ Map[String, DomainElement], scope: Scope): Option[DomainElement]
    Definition Classes
    Declarations
  54. def findHeader(key: String, scope: Scope): Option[Parameter]
    Definition Classes
    WebApiDeclarations
  55. def findInExternals(url: String): Option[AnyShape]
    Definition Classes
    ShapeDeclarations
  56. def findInExternalsLibs(lib: String, name: String): Option[AnyShape]
    Definition Classes
    ShapeDeclarations
  57. def findManyForType(key: String, map: (Declarations) ⇒ Map[String, List[DomainElement]], scope: Scope): Option[List[DomainElement]]
    Definition Classes
    Declarations
  58. def findMessage(key: String, scope: Scope): Option[Message]
    Definition Classes
    WebApiDeclarations
  59. def findMessageBindings(key: String, scope: Scope): Option[MessageBindings]
    Definition Classes
    WebApiDeclarations
  60. def findMessageTrait(key: String, scope: Scope): Option[Message]
    Definition Classes
    WebApiDeclarations
  61. def findNamedExample(key: String, error: Option[(String) ⇒ Unit]): Option[Example]
    Definition Classes
    ShapeDeclarations
  62. def findNamedExampleOrError(ast: YPart)(key: String): Example
    Definition Classes
    ShapeDeclarations
  63. def findOperationBindings(key: String, scope: Scope): Option[OperationBindings]
    Definition Classes
    WebApiDeclarations
  64. def findOperationTrait(key: String, scope: Scope): Option[Operation]
    Definition Classes
    WebApiDeclarations
  65. def findParameter(key: String, scope: Scope): Option[Parameter]
    Definition Classes
    WebApiDeclarations
  66. def findParameterOrError(ast: YPart)(key: String, scope: Scope): Parameter
    Definition Classes
    WebApiDeclarations
  67. def findPayload(key: String, scope: Scope): Option[Payload]
    Definition Classes
    WebApiDeclarations
  68. def findRequestBody(key: String, scope: Scope): Option[Request]
    Definition Classes
    WebApiDeclarations
  69. def findResourceType(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[ResourceType]
    Definition Classes
    WebApiDeclarations
  70. def findResourceTypeOrError(ast: YPart)(key: String, scope: Scope): ResourceType
    Definition Classes
    WebApiDeclarations
  71. def findResponse(key: String, scope: Scope): Option[Response]
    Definition Classes
    WebApiDeclarations
  72. def findResponseOrError(ast: YPart)(key: String, searchScope: Scope): Response
    Definition Classes
    WebApiDeclarations
  73. def findSecurityScheme(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[SecurityScheme]
    Definition Classes
    WebApiDeclarations
  74. def findSecuritySchemeOrError(ast: YPart)(key: String, scope: Scope): SecurityScheme
    Definition Classes
    WebApiDeclarations
  75. def findServer(key: String, scope: Scope): Option[Server]
    Definition Classes
    WebApiDeclarations
  76. def findServerBindings(key: String, scope: Scope): Option[ServerBindings]
    Definition Classes
    WebApiDeclarations
  77. def findServerVariable(key: String, scope: Scope): Option[Parameter]
    Definition Classes
    WebApiDeclarations
  78. def findTemplatedLink(key: String, scope: Scope): Option[TemplatedLink]
    Definition Classes
    WebApiDeclarations
  79. def findTraitOrError(ast: YPart)(key: String, scope: Scope): Trait
    Definition Classes
    WebApiDeclarations
  80. def findType(key: String, scope: Scope, error: Option[(String) ⇒ Unit]): Option[AnyShape]
    Definition Classes
    ShapeDeclarations
  81. var fragments: Map[String, FragmentRef]
    Definition Classes
    Declarations
  82. val futureDeclarations: FutureDeclarations
    Definition Classes
    RamlWebApiDeclarations → WebApiDeclarations
  83. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  84. def getOrCreateLibrary(alias: String): WebApiDeclarations

    Get or create specified library.

    Get or create specified library.

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

Inherited from ShapeDeclarations

Inherited from Declarations

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped