class ExtensionWebApiDeclarations extends RamlWebApiDeclarations
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- ExtensionWebApiDeclarations
- RamlWebApiDeclarations
- WebApiDeclarations
- ShapeDeclarations
- Declarations
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- All
Instance Constructors
- new ExtensionWebApiDeclarations(parentDeclarations: RamlWebApiDeclarations, alias: Option[String], errorHandler: AMFErrorHandler, futureDeclarations: FutureDeclarations)
Type Members
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
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
-
def
+=(indexKey: String, element: DomainElement): ExtensionWebApiDeclarations.this.type
- Definition Classes
- WebApiDeclarations → ShapeDeclarations → Declarations
-
def
+=(element: DomainElement): ExtensionWebApiDeclarations.this.type
- Definition Classes
- WebApiDeclarations → Declarations
-
def
+=(doc: (String, (Shape, Map[String, Shape]))): ExtensionWebApiDeclarations.this.type
- Definition Classes
- ShapeDeclarations
-
def
+=(extension: Map[String, Dialect]): ShapeDeclarations
- Definition Classes
- ShapeDeclarations
-
def
+=(indexKey: String, fragment: Fragment): Declarations
- Definition Classes
- Declarations
-
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()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
absorb(other: RamlWebApiDeclarations): Unit
- Definition Classes
- RamlWebApiDeclarations
-
def
addLibrary(alias: String, declarations: Declarations): Unit
- Definition Classes
- WebApiDeclarations → Declarations
-
def
addSchema(indexKey: String, s: Shape): Unit
- Attributes
- protected
- Definition Classes
- ShapeDeclarations
-
val
alias: Option[String]
- Definition Classes
- ExtensionWebApiDeclarations → RamlWebApiDeclarations → ShapeDeclarations
-
def
aliased(name: String): String
- Definition Classes
- ShapeDeclarations
-
var
annotations: Map[String, CustomDomainProperty]
- Definition Classes
- Declarations
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
var
avroDocumentFragmentAliases: Set[String]
- Definition Classes
- WebApiDeclarations
-
var
callbacks: Map[String, List[Callback]]
- Definition Classes
- WebApiDeclarations
-
var
channelBindings: Map[String, ChannelBindings]
- Definition Classes
- WebApiDeclarations
-
var
channels: Map[String, EndPoint]
- Definition Classes
- WebApiDeclarations
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @IntrinsicCandidate()
-
var
componentExternalDocs: Map[String, CreativeWork]
- Definition Classes
- WebApiDeclarations
-
var
componentTags: Map[String, Tag]
- Definition Classes
- WebApiDeclarations
-
var
concreteOperations: Map[String, Operation]
- Definition Classes
- WebApiDeclarations
-
def
copy(): WebApiDeclarations
- Definition Classes
- WebApiDeclarations → ShapeDeclarations
-
def
copy[T <: ShapeDeclarations](next: T): T
- Definition Classes
- ShapeDeclarations
-
var
correlationIds: Map[String, CorrelationId]
- Definition Classes
- WebApiDeclarations
-
def
declarables(): Seq[DomainElement]
- Definition Classes
- WebApiDeclarations → Declarations
-
var
documentFragments: Map[String, (Shape, Map[String, Shape])]
- Definition Classes
- ShapeDeclarations
-
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
-
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
-
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
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
error(message: String, pos: SourceLocation): Unit
- Attributes
- protected
- Definition Classes
- Declarations
-
val
errorHandler: AMFErrorHandler
- Definition Classes
- ExtensionWebApiDeclarations → RamlWebApiDeclarations → WebApiDeclarations
-
var
examples: Map[String, Example]
- Definition Classes
- ShapeDeclarations
-
def
existsExternalAlias(lib: String): Boolean
- Definition Classes
- RamlWebApiDeclarations
-
var
extensions: Map[String, Dialect]
- Definition Classes
- ShapeDeclarations
-
var
externalLibs: Map[String, Map[String, AnyShape]]
- Definition Classes
- ShapeDeclarations
-
var
externalShapes: Map[String, AnyShape]
- Definition Classes
- ShapeDeclarations
-
val
extractor: QualifiedNameExtractor
- Definition Classes
- WebApiDeclarations
-
def
findAnnotation(key: String, scope: Scope): Option[CustomDomainProperty]
- Definition Classes
- Declarations
-
def
findAnnotationOrError(pos: SourceLocation)(key: String, scope: Scope): CustomDomainProperty
- Definition Classes
- Declarations
-
def
findCallbackInDeclarations(key: String, scope: Scope = Named): Option[List[Callback]]
- Definition Classes
- WebApiDeclarations
-
def
findChannel(key: String, scope: Scope): Option[EndPoint]
- Definition Classes
- WebApiDeclarations
-
def
findChannelBindings(key: String, scope: Scope): Option[ChannelBindings]
- Definition Classes
- WebApiDeclarations
-
def
findComponentExternalDocs(key: String, scope: Scope): Option[CreativeWork]
Find an externalDocs declared under AsyncAPI 3.0
components.externalDocs.Find an externalDocs declared under AsyncAPI 3.0
components.externalDocs.- Definition Classes
- WebApiDeclarations
-
def
findComponentTag(key: String, scope: Scope): Option[Tag]
Find a tag declared under AsyncAPI 3.0
components.tags.Find a tag declared under AsyncAPI 3.0
components.tags.- Definition Classes
- WebApiDeclarations
-
def
findCorrelationId(key: String, scope: Scope): Option[CorrelationId]
- Definition Classes
- WebApiDeclarations
-
def
findDeclaredTypeInDocFragment(doc: String, name: String): Option[Shape]
- Definition Classes
- ShapeDeclarations
-
def
findDialect(key: String): Option[Dialect]
- Definition Classes
- WebApiDeclarations
-
def
findDocumentations(key: String, scope: Scope, error: Option[(String) ⇒ Unit]): Option[CreativeWork]
- Definition Classes
- ShapeDeclarations
-
def
findEncodedTypeInDocFragment(doc: String): Option[Shape]
- Definition Classes
- ShapeDeclarations
-
def
findEquivalent(element: DomainElement): Option[DomainElement]
Find domain element with the same name.
Find domain element with the same name.
- Definition Classes
- WebApiDeclarations → Declarations
-
def
findExample(key: String, scope: Scope): Option[Example]
- Definition Classes
- ShapeDeclarations
-
def
findForType(key: String, map: (Declarations) ⇒ Map[String, DomainElement], scope: Scope): Option[DomainElement]
- Definition Classes
- ExtensionWebApiDeclarations → Declarations
-
def
findHeader(key: String, scope: Scope): Option[Parameter]
- Definition Classes
- WebApiDeclarations
-
def
findInExternals(url: String): Option[AnyShape]
- Definition Classes
- ShapeDeclarations
-
def
findInExternalsLibs(lib: String, name: String): Option[AnyShape]
- Definition Classes
- ShapeDeclarations
-
def
findManyForType(key: String, map: (Declarations) ⇒ Map[String, List[DomainElement]], scope: Scope): Option[List[DomainElement]]
- Definition Classes
- Declarations
-
def
findMessage(key: String, scope: Scope): Option[Message]
- Definition Classes
- WebApiDeclarations
-
def
findMessageBindings(key: String, scope: Scope): Option[MessageBindings]
- Definition Classes
- WebApiDeclarations
-
def
findMessageTrait(key: String, scope: Scope): Option[Message]
- Definition Classes
- WebApiDeclarations
-
def
findNamedExample(key: String, error: Option[(String) ⇒ Unit]): Option[Example]
- Definition Classes
- ShapeDeclarations
-
def
findNamedExampleOrError(ast: YPart)(key: String): Example
- Definition Classes
- ShapeDeclarations
-
def
findOperation(key: String, scope: Scope): Option[Operation]
Find a concrete operation declared under AsyncAPI 3.0
components.operations.Find a concrete operation declared under AsyncAPI 3.0
components.operations. Distinct from operation traits (operationTraits); concrete operations are not abstract.- Definition Classes
- WebApiDeclarations
-
def
findOperationBindings(key: String, scope: Scope): Option[OperationBindings]
- Definition Classes
- WebApiDeclarations
-
def
findOperationTrait(key: String, scope: Scope): Option[Operation]
- Definition Classes
- WebApiDeclarations
-
def
findParameter(key: String, scope: Scope): Option[Parameter]
- Definition Classes
- WebApiDeclarations
-
def
findParameterOrError(ast: YPart)(key: String, scope: Scope): Parameter
- Definition Classes
- WebApiDeclarations
-
def
findPayload(key: String, scope: Scope): Option[Payload]
- Definition Classes
- WebApiDeclarations
-
def
findReply(key: String, scope: Scope): Option[OperationReply]
- Definition Classes
- WebApiDeclarations
-
def
findReplyAddress(key: String, scope: Scope): Option[OperationReplyAddress]
- Definition Classes
- WebApiDeclarations
-
def
findRequestBody(key: String, scope: Scope): Option[Request]
- Definition Classes
- WebApiDeclarations
-
def
findResourceType(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[ResourceType]
- Definition Classes
- WebApiDeclarations
-
def
findResourceTypeOrError(ast: YPart)(key: String, scope: Scope): ResourceType
- Definition Classes
- WebApiDeclarations
-
def
findResponse(key: String, scope: Scope): Option[Response]
- Definition Classes
- WebApiDeclarations
-
def
findResponseOrError(ast: YPart)(key: String, searchScope: Scope): Response
- Definition Classes
- WebApiDeclarations
-
def
findSecurityScheme(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[SecurityScheme]
- Definition Classes
- WebApiDeclarations
-
def
findSecuritySchemeOrError(ast: YPart)(key: String, scope: Scope): SecurityScheme
- Definition Classes
- WebApiDeclarations
-
def
findServer(key: String, scope: Scope): Option[Server]
- Definition Classes
- WebApiDeclarations
-
def
findServerBindings(key: String, scope: Scope): Option[ServerBindings]
- Definition Classes
- WebApiDeclarations
-
def
findServerVariable(key: String, scope: Scope): Option[Parameter]
- Definition Classes
- WebApiDeclarations
-
def
findTemplatedLink(key: String, scope: Scope): Option[TemplatedLink]
- Definition Classes
- WebApiDeclarations
-
def
findTraitOrError(ast: YPart)(key: String, scope: Scope): Trait
- Definition Classes
- WebApiDeclarations
-
def
findType(key: String, scope: Scope, error: Option[(String) ⇒ Unit]): Option[AnyShape]
- Definition Classes
- ShapeDeclarations
-
var
fragments: Map[String, FragmentRef]
- Definition Classes
- Declarations
-
val
futureDeclarations: FutureDeclarations
- Definition Classes
- ExtensionWebApiDeclarations → RamlWebApiDeclarations → WebApiDeclarations
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
-
def
getOrCreateLibrary(alias: String): WebApiDeclarations
Get or create specified library.
Get or create specified library.
- Definition Classes
- WebApiDeclarations → Declarations
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
-
var
headers: Map[String, Parameter]
- Definition Classes
- WebApiDeclarations
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
var
libraries: Map[String, Declarations]
- Definition Classes
- Declarations
-
var
links: Map[String, TemplatedLink]
- Definition Classes
- WebApiDeclarations
-
def
merge(other: RamlWebApiDeclarations): RamlWebApiDeclarations
- Definition Classes
- RamlWebApiDeclarations
-
def
merge(other: WebApiDeclarations): WebApiDeclarations
- Definition Classes
- WebApiDeclarations
-
def
mergeParts(other: WebApiDeclarations, merged: WebApiDeclarations): Unit
- Attributes
- protected
- Definition Classes
- WebApiDeclarations
-
var
messageBindings: Map[String, MessageBindings]
- Definition Classes
- WebApiDeclarations
-
var
messageTraits: Map[String, Message]
- Definition Classes
- WebApiDeclarations
-
var
messages: Map[String, Message]
- Definition Classes
- WebApiDeclarations
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
nonEmpty: Boolean
- Definition Classes
- WebApiDeclarations
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
-
var
operationBindings: Map[String, OperationBindings]
- Definition Classes
- WebApiDeclarations
-
var
operationTraits: Map[String, Operation]
- Definition Classes
- WebApiDeclarations
-
var
others: Map[String, BaseUnit]
- Definition Classes
- WebApiDeclarations
-
def
parameterPayload(parameter: Parameter): Payload
- Definition Classes
- WebApiDeclarations
-
var
parameters: Map[String, Parameter]
- Definition Classes
- WebApiDeclarations
-
var
payloads: Map[String, Payload]
- Definition Classes
- WebApiDeclarations
-
def
promoteExternalToDataTypeFragment(text: String, fullRef: String, shape: Shape): Unit
- Definition Classes
- ShapeDeclarations
-
var
promotedFragments: Seq[Fragment]
- Definition Classes
- Declarations
-
def
registerExternalLib(url: String, content: Map[String, AnyShape]): ShapeDeclarations
- Definition Classes
- ShapeDeclarations
-
def
registerExternalRef(external: (String, AnyShape)): ShapeDeclarations
- Definition Classes
- ShapeDeclarations
-
def
registerHeader(header: Parameter): Unit
- Definition Classes
- WebApiDeclarations
-
def
registerOasParameter(oasParameter: OasParameter): Unit
- Definition Classes
- WebApiDeclarations
-
var
replies: Map[String, OperationReply]
- Definition Classes
- WebApiDeclarations
-
var
replyAddresses: Map[String, OperationReplyAddress]
- Definition Classes
- WebApiDeclarations
-
var
requests: Map[String, Request]
- Definition Classes
- WebApiDeclarations
-
var
resourceTypes: Map[String, ResourceType]
- Definition Classes
- WebApiDeclarations
-
var
responses: Map[String, Response]
- Definition Classes
- WebApiDeclarations
-
var
securitySchemes: Map[String, SecurityScheme]
- Definition Classes
- WebApiDeclarations
-
var
serverBindings: Map[String, ServerBindings]
- Definition Classes
- WebApiDeclarations
-
var
serverVariables: Map[String, Parameter]
- Definition Classes
- WebApiDeclarations
-
var
servers: Map[String, Server]
- Definition Classes
- WebApiDeclarations
-
def
setLibraries(libraries: Map[String, Declarations]): Unit
- Definition Classes
- WebApiDeclarations
-
var
shapes: Map[String, Shape]
- Definition Classes
- ShapeDeclarations
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
var
traits: Map[String, Trait]
- Definition Classes
- WebApiDeclarations
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
withExtensions(extensions: Map[String, Dialect]): ShapeDeclarations
- Definition Classes
- ShapeDeclarations
-
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
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated
-
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
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.