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

    Find domain element with the same name.

    Find domain element with the same name.

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

    Get or create specified library.

    Get or create specified library.

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