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

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

    Find domain element with the same name.

    Find domain element with the same name.

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

    Get or create specified library.

    Get or create specified library.

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

    (Since version ) see corresponding Javadoc for more information.

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