Packages

c

amf.apicontract.internal.spec.common

ExtensionWebApiDeclarations

class ExtensionWebApiDeclarations extends RamlWebApiDeclarations

Linear Supertypes
RamlWebApiDeclarations, WebApiDeclarations, Declarations, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ExtensionWebApiDeclarations
  2. RamlWebApiDeclarations
  3. WebApiDeclarations
  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 ExtensionWebApiDeclarations(externalShapes: Map[String, AnyShape] = Map(), externalLibs: Map[String, Map[String, AnyShape]] = Map(), parentDeclarations: 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 ExtensionWebApiDeclarations to any2stringadd[ExtensionWebApiDeclarations] 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
    Definition Classes
    WebApiDeclarations
  6. def +=(fragment: (String, Fragment)): Declarations
    Definition Classes
    Declarations
  7. def ->[B](y: B): (ExtensionWebApiDeclarations, B)
    Implicit
    This member is added by an implicit conversion from ExtensionWebApiDeclarations to ArrowAssoc[ExtensionWebApiDeclarations] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  8. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def absorb(other: RamlWebApiDeclarations): Unit
    Definition Classes
    RamlWebApiDeclarations
  10. def addSchema(s: Shape): Unit
    Attributes
    protected
    Definition Classes
    WebApiDeclarations
  11. def addSchemaExtension(s: Shape): Unit
    Attributes
    protected
    Definition Classes
    WebApiDeclarations
  12. val alias: Option[String]
  13. def aliased(name: String): String
    Definition Classes
    WebApiDeclarations
  14. var annotations: Map[String, CustomDomainProperty]
    Definition Classes
    Declarations
  15. var anns: Map[String, CustomDomainProperty]
    Definition Classes
    WebApiDeclarations
  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. var correlationIds: Map[String, CorrelationId]
    Definition Classes
    WebApiDeclarations
  21. def declarables(): Seq[DomainElement]
    Definition Classes
    WebApiDeclarations → Declarations
  22. def ensuring(cond: (ExtensionWebApiDeclarations) ⇒ Boolean, msg: ⇒ Any): ExtensionWebApiDeclarations
    Implicit
    This member is added by an implicit conversion from ExtensionWebApiDeclarations to Ensuring[ExtensionWebApiDeclarations] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. def ensuring(cond: (ExtensionWebApiDeclarations) ⇒ Boolean): ExtensionWebApiDeclarations
    Implicit
    This member is added by an implicit conversion from ExtensionWebApiDeclarations to Ensuring[ExtensionWebApiDeclarations] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. def ensuring(cond: Boolean, msg: ⇒ Any): ExtensionWebApiDeclarations
    Implicit
    This member is added by an implicit conversion from ExtensionWebApiDeclarations to Ensuring[ExtensionWebApiDeclarations] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. def ensuring(cond: Boolean): ExtensionWebApiDeclarations
    Implicit
    This member is added by an implicit conversion from ExtensionWebApiDeclarations to Ensuring[ExtensionWebApiDeclarations] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  26. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  28. def error(message: String, pos: SourceLocation): Unit
    Attributes
    protected
    Definition Classes
    Declarations
  29. val errorHandler: AMFErrorHandler
  30. var examples: Map[String, Example]
    Definition Classes
    WebApiDeclarations
  31. def existsExternalAlias(lib: String): Boolean
    Definition Classes
    RamlWebApiDeclarations
  32. var extensions: Map[String, Dialect]
    Definition Classes
    WebApiDeclarations
  33. var externalLibs: Map[String, Map[String, AnyShape]]
    Definition Classes
    RamlWebApiDeclarations
  34. var externalShapes: Map[String, AnyShape]
    Definition Classes
    RamlWebApiDeclarations
  35. def findAnnotation(key: String, scope: Scope): Option[CustomDomainProperty]
    Definition Classes
    Declarations
  36. def findAnnotationOrError(pos: SourceLocation)(key: String, scope: Scope): CustomDomainProperty
    Definition Classes
    Declarations
  37. def findCallbackInDeclarations(key: String): Option[List[Callback]]
    Definition Classes
    WebApiDeclarations
  38. def findChannelBindings(key: String, scope: Scope): Option[ChannelBindings]
    Definition Classes
    WebApiDeclarations
  39. def findCorrelationId(key: String, scope: Scope): Option[CorrelationId]
    Definition Classes
    WebApiDeclarations
  40. def findDialect(key: String): Option[Dialect]
    Definition Classes
    WebApiDeclarations
  41. def findDocumentations(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[CreativeWork]
    Definition Classes
    WebApiDeclarations
  42. def findEquivalent(element: DomainElement): Option[DomainElement]

    Find domain element with the same name.

    Find domain element with the same name.

    Definition Classes
    WebApiDeclarations → Declarations
  43. def findExample(key: String, scope: Scope): Option[Example]
    Definition Classes
    WebApiDeclarations
  44. def findForType(key: String, map: (Declarations) ⇒ Map[String, DomainElement], scope: Scope): Option[DomainElement]
    Definition Classes
    ExtensionWebApiDeclarations → Declarations
  45. def findHeader(key: String, scope: Scope): Option[Parameter]
    Definition Classes
    WebApiDeclarations
  46. def findInExternals(url: String): Option[AnyShape]
    Definition Classes
    RamlWebApiDeclarations
  47. def findInExternalsLibs(lib: String, name: String): Option[AnyShape]
    Definition Classes
    RamlWebApiDeclarations
  48. def findMessage(key: String, scope: Scope): Option[Message]
    Definition Classes
    WebApiDeclarations
  49. def findMessageBindings(key: String, scope: Scope): Option[MessageBindings]
    Definition Classes
    WebApiDeclarations
  50. def findMessageTrait(key: String, scope: Scope): Option[Message]
    Definition Classes
    WebApiDeclarations
  51. def findNamedExample(key: String, error: Option[(String) ⇒ Unit] = None): Option[Example]
    Definition Classes
    WebApiDeclarations
  52. def findNamedExampleOrError(ast: YPart)(key: String): Example
    Definition Classes
    WebApiDeclarations
  53. def findOperationBindings(key: String, scope: Scope): Option[OperationBindings]
    Definition Classes
    WebApiDeclarations
  54. def findOperationTrait(key: String, scope: Scope): Option[Operation]
    Definition Classes
    WebApiDeclarations
  55. def findParameter(key: String, scope: Scope): Option[Parameter]
    Definition Classes
    WebApiDeclarations
  56. def findParameterOrError(ast: YPart)(key: String, scope: Scope): Parameter
    Definition Classes
    WebApiDeclarations
  57. def findPayload(key: String, scope: Scope): Option[Payload]
    Definition Classes
    WebApiDeclarations
  58. def findRequestBody(key: String, scope: Scope): Option[Request]
    Definition Classes
    WebApiDeclarations
  59. def findResourceType(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[ResourceType]
    Definition Classes
    WebApiDeclarations
  60. def findResourceTypeOrError(ast: YPart)(key: String, scope: Scope): ResourceType
    Definition Classes
    WebApiDeclarations
  61. def findResponse(key: String, scope: Scope): Option[Response]
    Definition Classes
    WebApiDeclarations
  62. def findResponseOrError(ast: YPart)(key: String, searchScope: Scope): Response
    Definition Classes
    WebApiDeclarations
  63. def findSecurityScheme(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[SecurityScheme]
    Definition Classes
    WebApiDeclarations
  64. def findSecuritySchemeOrError(ast: YPart)(key: String, scope: Scope): SecurityScheme
    Definition Classes
    WebApiDeclarations
  65. def findServerBindings(key: String, scope: Scope): Option[ServerBindings]
    Definition Classes
    WebApiDeclarations
  66. def findTemplatedLink(key: String, scope: Scope): Option[TemplatedLink]
    Definition Classes
    WebApiDeclarations
  67. def findTraitOrError(ast: YPart)(key: String, scope: Scope): Trait
    Definition Classes
    WebApiDeclarations
  68. def findType(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[AnyShape]
    Definition Classes
    WebApiDeclarations
  69. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ExtensionWebApiDeclarations to StringFormat[ExtensionWebApiDeclarations] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  70. var fragments: Map[String, FragmentRef]
    Definition Classes
    Declarations
  71. var frags: Map[String, FragmentRef]
    Definition Classes
    WebApiDeclarations
  72. val futureDeclarations: FutureDeclarations
  73. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  74. def getOrCreateLibrary(alias: String): WebApiDeclarations

    Get or create specified library.

    Get or create specified library.

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

Inherited from WebApiDeclarations

Inherited from Declarations

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped