Packages

class WebApiDeclarations extends Declarations

Declarations object.

Linear Supertypes
Declarations, AnyRef, Any
Known Subclasses
AsyncWebApiDeclarations, ExtensionWebApiDeclarations, OasLikeWebApiDeclarations, OasWebApiDeclarations, RamlWebApiDeclarations
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WebApiDeclarations
  2. Declarations
  3. AnyRef
  4. 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], libs: Map[String, WebApiDeclarations] = Map(), frags: Map[String, FragmentRef] = Map(), shapes: Map[String, Shape] = Map(), anns: Map[String, CustomDomainProperty] = Map(), resourceTypes: Map[String, ResourceType] = Map(), parameters: Map[String, Parameter] = Map(), payloads: Map[String, Payload] = Map(), traits: Map[String, Trait] = Map(), securitySchemes: Map[String, SecurityScheme] = Map(), responses: Map[String, Response] = Map(), examples: Map[String, Example] = Map(), requests: Map[String, Request] = Map(), headers: Map[String, Parameter] = Map(), links: Map[String, TemplatedLink] = Map(), correlationIds: Map[String, CorrelationId] = Map(), callbacks: Map[String, List[Callback]] = Map(), messages: Map[String, Message] = Map(), messageBindings: Map[String, MessageBindings] = Map(), operationBindings: Map[String, OperationBindings] = Map(), channelBindings: Map[String, ChannelBindings] = Map(), serverBindings: Map[String, ServerBindings] = Map(), operationTraits: Map[String, Operation] = Map(), messageTraits: Map[String, Message] = Map(), errorHandler: AMFErrorHandler, futureDeclarations: FutureDeclarations, others: Map[String, BaseUnit] = Map())

Type Members

  1. trait ErrorDeclaration extends AnyRef
    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 +=(element: DomainElement): WebApiDeclarations
    Definition Classes
    WebApiDeclarations → Declarations
  5. def +=(fragment: (String, Fragment)): Declarations
    Definition Classes
    Declarations
  6. 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()
  7. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def addSchema(s: Shape): Unit
    Attributes
    protected
  9. val alias: Option[String]
  10. def aliased(name: String): String
  11. var annotations: Map[String, CustomDomainProperty]
    Definition Classes
    Declarations
  12. var anns: Map[String, CustomDomainProperty]
  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. var callbacks: Map[String, List[Callback]]
  15. var channelBindings: Map[String, ChannelBindings]
  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  17. var correlationIds: Map[String, CorrelationId]
  18. def declarables(): Seq[DomainElement]
    Definition Classes
    WebApiDeclarations → Declarations
  19. 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
  20. 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
  21. 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
  22. 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
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  25. def error(message: String, pos: SourceLocation): Unit
    Attributes
    protected
    Definition Classes
    Declarations
  26. val errorHandler: AMFErrorHandler
  27. var examples: Map[String, Example]
  28. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  29. def findAnnotation(key: String, scope: Scope): Option[CustomDomainProperty]
    Definition Classes
    Declarations
  30. def findAnnotationOrError(pos: SourceLocation)(key: String, scope: Scope): CustomDomainProperty
    Definition Classes
    Declarations
  31. def findCallbackInDeclarations(key: String): Option[List[Callback]]
  32. def findChannelBindings(key: String, scope: Scope): Option[ChannelBindings]
  33. def findCorrelationId(key: String, scope: Scope): Option[CorrelationId]
  34. def findDocumentations(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[CreativeWork]
  35. def findEquivalent(element: DomainElement): Option[DomainElement]

    Find domain element with the same name.

    Find domain element with the same name.

    Definition Classes
    WebApiDeclarations → Declarations
  36. def findExample(key: String, scope: Scope): Option[Example]
  37. def findForType(key: String, map: (Declarations) ⇒ Map[String, DomainElement], scope: Scope): Option[DomainElement]
    Definition Classes
    Declarations
  38. def findHeader(key: String, scope: Scope): Option[Parameter]
  39. def findMessage(key: String, scope: Scope): Option[Message]
  40. def findMessageBindings(key: String, scope: Scope): Option[MessageBindings]
  41. def findMessageTrait(key: String, scope: Scope): Option[Message]
  42. def findNamedExample(key: String, error: Option[(String) ⇒ Unit] = None): Option[Example]
  43. def findNamedExampleOrError(ast: YPart)(key: String): Example
  44. def findOperationBindings(key: String, scope: Scope): Option[OperationBindings]
  45. def findOperationTrait(key: String, scope: Scope): Option[Operation]
  46. def findParameter(key: String, scope: Scope): Option[Parameter]
  47. def findParameterOrError(ast: YPart)(key: String, scope: Scope): Parameter
  48. def findPayload(key: String, scope: Scope): Option[Payload]
  49. def findRequestBody(key: String, scope: Scope): Option[Request]
  50. def findResourceType(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[ResourceType]
  51. def findResourceTypeOrError(ast: YPart)(key: String, scope: Scope): ResourceType
  52. def findResponse(key: String, scope: Scope): Option[Response]
  53. def findResponseOrError(ast: YPart)(key: String, searchScope: Scope): Response
  54. def findSecurityScheme(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[SecurityScheme]
  55. def findSecuritySchemeOrError(ast: YPart)(key: String, scope: Scope): SecurityScheme
  56. def findServerBindings(key: String, scope: Scope): Option[ServerBindings]
  57. def findTemplatedLink(key: String, scope: Scope): Option[TemplatedLink]
  58. def findTraitOrError(ast: YPart)(key: String, scope: Scope): Trait
  59. def findType(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[AnyShape]
  60. 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
    @inline()
  61. var fragments: Map[String, FragmentRef]
    Definition Classes
    Declarations
  62. var frags: Map[String, FragmentRef]
  63. val futureDeclarations: FutureDeclarations
  64. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  65. def getOrCreateLibrary(alias: String): WebApiDeclarations

    Get or create specified library.

    Get or create specified library.

    Definition Classes
    WebApiDeclarations → Declarations
  66. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  67. var headers: Map[String, Parameter]
  68. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  69. var libraries: Map[String, Declarations]
    Definition Classes
    Declarations
  70. var libs: Map[String, WebApiDeclarations]
  71. var links: Map[String, TemplatedLink]
  72. def merge(other: WebApiDeclarations): WebApiDeclarations
  73. def mergeParts(other: WebApiDeclarations, merged: WebApiDeclarations): Unit
    Attributes
    protected
  74. var messageBindings: Map[String, MessageBindings]
  75. var messageTraits: Map[String, Message]
  76. var messages: Map[String, Message]
  77. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  78. def nonEmpty: Boolean
  79. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  80. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  81. var operationBindings: Map[String, OperationBindings]
  82. var operationTraits: Map[String, Operation]
  83. var others: Map[String, BaseUnit]
  84. def parameterPayload(parameter: Parameter): Payload
  85. var parameters: Map[String, Parameter]
  86. var payloads: Map[String, Payload]
  87. def promoteExternaltoDataTypeFragment(text: String, fullRef: String, shape: Shape): Shape
  88. var promotedFragments: Seq[Fragment]
    Definition Classes
    Declarations
  89. def registerHeader(header: Parameter): Unit
  90. def registerOasParameter(oasParameter: OasParameter): Unit
  91. var requests: Map[String, Request]
  92. var resourceTypes: Map[String, ResourceType]
  93. var responses: Map[String, Response]
  94. var securitySchemes: Map[String, SecurityScheme]
  95. var serverBindings: Map[String, ServerBindings]
  96. var shapes: Map[String, Shape]
  97. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  98. def toString(): String
    Definition Classes
    AnyRef → Any
  99. var traits: Map[String, Trait]
  100. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  101. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  102. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  103. 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

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