Packages

c

amf.apicontract.internal.spec.common

ExtensionWebApiDeclarations

class ExtensionWebApiDeclarations extends RamlWebApiDeclarations

Linear Supertypes
RamlWebApiDeclarations, WebApiDeclarations, ShapeDeclarations, Declarations, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ExtensionWebApiDeclarations
  2. RamlWebApiDeclarations
  3. WebApiDeclarations
  4. ShapeDeclarations
  5. Declarations
  6. AnyRef
  7. 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(parentDeclarations: RamlWebApiDeclarations, alias: Option[String], errorHandler: AMFErrorHandler, futureDeclarations: FutureDeclarations)

Type Members

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

    Find domain element with the same name.

    Find domain element with the same name.

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

    Get or create specified library.

    Get or create specified library.

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

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