Packages

class WebApiDeclarations extends ShapeDeclarations

Declarations object.

Linear Supertypes
ShapeDeclarations, Declarations, AnyRef, Any
Known Subclasses
AsyncWebApiDeclarations, 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)

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 → ShapeDeclarations → Declarations
  5. def +=(doc: (String, (Shape, Map[String, Shape]))): WebApiDeclarations.this.type
    Definition Classes
    ShapeDeclarations
  6. def +=(extension: Map[String, Dialect]): ShapeDeclarations
    Definition Classes
    ShapeDeclarations
  7. def +=(fragment: (String, Fragment)): Declarations
    Definition Classes
    Declarations
  8. 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()
  9. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def addLibrary(alias: String, declarations: Declarations): Unit
    Definition Classes
    WebApiDeclarations → Declarations
  11. def addSchema(s: Shape): Unit
    Attributes
    protected
    Definition Classes
    ShapeDeclarations
  12. val alias: Option[String]
    Definition Classes
    ShapeDeclarations
  13. def aliased(name: String): String
    Definition Classes
    ShapeDeclarations
  14. var annotations: Map[String, CustomDomainProperty]
    Definition Classes
    Declarations
  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() @HotSpotIntrinsicCandidate()
  19. def copy(): WebApiDeclarations
    Definition Classes
    WebApiDeclarations → ShapeDeclarations
  20. def copy[T <: ShapeDeclarations](next: T): T
    Definition Classes
    ShapeDeclarations
  21. var correlationIds: Map[String, CorrelationId]
  22. def declarables(): Seq[DomainElement]
    Definition Classes
    WebApiDeclarations → Declarations
  23. var documentFragments: Map[String, (Shape, Map[String, Shape])]
    Definition Classes
    ShapeDeclarations
  24. 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
  25. 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
  26. 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
  27. 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
  28. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  30. def error(message: String, pos: SourceLocation): Unit
    Attributes
    protected
    Definition Classes
    Declarations
  31. val errorHandler: AMFErrorHandler
  32. var examples: Map[String, Example]
    Definition Classes
    ShapeDeclarations
  33. var extensions: Map[String, Dialect]
    Definition Classes
    ShapeDeclarations
  34. var externalLibs: Map[String, Map[String, AnyShape]]
    Definition Classes
    ShapeDeclarations
  35. var externalShapes: Map[String, AnyShape]
    Definition Classes
    ShapeDeclarations
  36. def findAnnotation(key: String, scope: Scope): Option[CustomDomainProperty]
    Definition Classes
    Declarations
  37. def findAnnotationOrError(pos: SourceLocation)(key: String, scope: Scope): CustomDomainProperty
    Definition Classes
    Declarations
  38. def findCallbackInDeclarations(key: String): Option[List[Callback]]
  39. def findChannelBindings(key: String, scope: Scope): Option[ChannelBindings]
  40. def findCorrelationId(key: String, scope: Scope): Option[CorrelationId]
  41. def findDeclaredTypeInDocFragment(doc: String, name: String): Option[Shape]
    Definition Classes
    ShapeDeclarations
  42. def findDialect(key: String): Option[Dialect]
  43. def findDocumentations(key: String, scope: Scope, error: Option[(String) ⇒ Unit]): Option[CreativeWork]
    Definition Classes
    ShapeDeclarations
  44. def findEquivalent(element: DomainElement): Option[DomainElement]

    Find domain element with the same name.

    Find domain element with the same name.

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

    Get or create specified library.

    Get or create specified library.

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

    (Since version ) see corresponding Javadoc for more information.

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