Packages

class RamlWebApiDeclarations extends WebApiDeclarations

Linear Supertypes
WebApiDeclarations, Declarations, AnyRef, Any
Known Subclasses
ExtensionWebApiDeclarations
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RamlWebApiDeclarations
  2. WebApiDeclarations
  3. Declarations
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RamlWebApiDeclarations(externalShapes: Map[String, AnyShape] = Map(), externalLibs: Map[String, Map[String, AnyShape]] = Map(), alias: Option[String], errorHandler: ErrorHandler, 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 +=(element: DomainElement): WebApiDeclarations
    Definition Classes
    WebApiDeclarations → Declarations
  4. def +=(fragment: (String, Fragment)): Declarations
    Definition Classes
    Declarations
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def absorb(other: RamlWebApiDeclarations): Unit
  7. def addSchema(s: Shape): Unit
    Attributes
    protected
    Definition Classes
    WebApiDeclarations
  8. val alias: Option[String]
    Definition Classes
    RamlWebApiDeclarations → WebApiDeclarations
  9. def aliased(name: String): String
    Definition Classes
    WebApiDeclarations
  10. var annotations: Map[String, CustomDomainProperty]
    Definition Classes
    Declarations
  11. var anns: Map[String, CustomDomainProperty]
    Definition Classes
    WebApiDeclarations
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. var callbacks: Map[String, List[Callback]]
    Definition Classes
    WebApiDeclarations
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  15. def declarables(): Seq[DomainElement]
    Definition Classes
    WebApiDeclarations → Declarations
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. def error(message: String, ast: YPart): Unit
    Attributes
    protected
    Definition Classes
    Declarations
  19. val errorHandler: ErrorHandler
    Definition Classes
    RamlWebApiDeclarations → WebApiDeclarations
  20. var examples: Map[String, Example]
    Definition Classes
    WebApiDeclarations
  21. def existsExternalAlias(lib: String): Boolean
  22. var externalLibs: Map[String, Map[String, AnyShape]]
  23. var externalShapes: Map[String, AnyShape]
  24. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  25. def findAnnotation(key: String, scope: Scope): Option[CustomDomainProperty]
    Definition Classes
    Declarations
  26. def findAnnotationOrError(ast: YPart)(key: String, scope: Scope): CustomDomainProperty
    Definition Classes
    Declarations
  27. def findCallbackInDeclarations(key: String): Option[List[Callback]]
    Definition Classes
    WebApiDeclarations
  28. def findDocumentations(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[CreativeWork]
    Definition Classes
    WebApiDeclarations
  29. def findEquivalent(element: DomainElement): Option[DomainElement]

    Find domain element with the same name.

    Find domain element with the same name.

    Definition Classes
    WebApiDeclarations → Declarations
  30. def findExample(key: String, scope: Scope): Option[Example]
    Definition Classes
    WebApiDeclarations
  31. def findForType(key: String, map: (Declarations) ⇒ Map[String, DomainElement], scope: Scope): Option[DomainElement]
    Definition Classes
    Declarations
  32. def findHeader(key: String, scope: Scope): Option[Parameter]
    Definition Classes
    WebApiDeclarations
  33. def findInExternals(url: String): Option[AnyShape]
  34. def findInExternalsLibs(lib: String, name: String): Option[AnyShape]
  35. def findNamedExample(key: String, error: Option[(String) ⇒ Unit] = None): Option[Example]
    Definition Classes
    WebApiDeclarations
  36. def findNamedExampleOrError(ast: YPart)(key: String): Example
    Definition Classes
    WebApiDeclarations
  37. def findParameter(key: String, scope: Scope): Option[Parameter]
    Definition Classes
    WebApiDeclarations
  38. def findParameterOrError(ast: YPart)(key: String, scope: Scope): Parameter
    Definition Classes
    WebApiDeclarations
  39. def findPayload(key: String, scope: Scope): Option[Payload]
    Definition Classes
    WebApiDeclarations
  40. def findRequestBody(key: String, scope: Scope): Option[Request]
    Definition Classes
    WebApiDeclarations
  41. def findResourceType(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[ResourceType]
    Definition Classes
    WebApiDeclarations
  42. def findResourceTypeOrError(ast: YPart)(key: String, scope: Scope): ResourceType
    Definition Classes
    WebApiDeclarations
  43. def findResponse(key: String, scope: Scope): Option[Response]
    Definition Classes
    WebApiDeclarations
  44. def findResponseOrError(ast: YPart)(key: String, searchScope: Scope): Response
    Definition Classes
    WebApiDeclarations
  45. def findSecurityScheme(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[SecurityScheme]
    Definition Classes
    WebApiDeclarations
  46. def findSecuritySchemeOrError(ast: YPart)(key: String, scope: Scope): SecurityScheme
    Definition Classes
    WebApiDeclarations
  47. def findTemplatedLink(key: String, scope: Scope): Option[TemplatedLink]
    Definition Classes
    WebApiDeclarations
  48. def findTraitOrError(ast: YPart)(key: String, scope: Scope): Trait
    Definition Classes
    WebApiDeclarations
  49. def findType(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[AnyShape]
    Definition Classes
    WebApiDeclarations
  50. var fragments: Map[String, FragmentRef]
    Definition Classes
    Declarations
  51. var frags: Map[String, FragmentRef]
    Definition Classes
    WebApiDeclarations
  52. val futureDeclarations: FutureDeclarations
    Definition Classes
    RamlWebApiDeclarations → WebApiDeclarations
  53. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  54. def getOrCreateLibrary(alias: String): WebApiDeclarations

    Get or create specified library.

    Get or create specified library.

    Definition Classes
    WebApiDeclarations → Declarations
  55. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  56. var headers: Map[String, Parameter]
    Definition Classes
    WebApiDeclarations
  57. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  58. var libraries: Map[String, Declarations]
    Definition Classes
    Declarations
  59. var libs: Map[String, WebApiDeclarations]
    Definition Classes
    WebApiDeclarations
  60. var links: Map[String, TemplatedLink]
    Definition Classes
    WebApiDeclarations
  61. def merge(other: RamlWebApiDeclarations): RamlWebApiDeclarations
  62. def merge(other: WebApiDeclarations): WebApiDeclarations
    Definition Classes
    WebApiDeclarations
  63. def mergeParts(other: WebApiDeclarations, merged: WebApiDeclarations): Unit
    Attributes
    protected
    Definition Classes
    WebApiDeclarations
  64. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  65. def nonEmpty: Boolean
    Definition Classes
    WebApiDeclarations
  66. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  67. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  68. var others: Map[String, BaseUnit]
    Definition Classes
    WebApiDeclarations
  69. def parameterPayload(parameter: Parameter): Payload
    Definition Classes
    WebApiDeclarations
  70. var parameters: Map[String, Parameter]
    Definition Classes
    WebApiDeclarations
  71. var payloads: Map[String, Payload]
    Definition Classes
    WebApiDeclarations
  72. def promoteExternaltoDataTypeFragment(text: String, fullRef: String, shape: Shape): Shape
    Definition Classes
    WebApiDeclarations
  73. var promotedFragments: Seq[Fragment]
    Definition Classes
    Declarations
  74. def registerExternalLib(url: String, content: Map[String, AnyShape]): WebApiDeclarations
  75. def registerExternalRef(external: (String, AnyShape)): WebApiDeclarations
  76. def registerHeader(header: Parameter): Unit
    Definition Classes
    WebApiDeclarations
  77. def registerOasParameter(oasParameter: OasParameter): Unit
    Definition Classes
    WebApiDeclarations
  78. var requests: Map[String, Request]
    Definition Classes
    WebApiDeclarations
  79. var resourceTypes: Map[String, ResourceType]
    Definition Classes
    WebApiDeclarations
  80. var responses: Map[String, Response]
    Definition Classes
    WebApiDeclarations
  81. var securitySchemes: Map[String, SecurityScheme]
    Definition Classes
    WebApiDeclarations
  82. var shapes: Map[String, Shape]
    Definition Classes
    WebApiDeclarations
  83. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  84. def toString(): String
    Definition Classes
    AnyRef → Any
  85. var traits: Map[String, Trait]
    Definition Classes
    WebApiDeclarations
  86. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  87. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  88. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from WebApiDeclarations

Inherited from Declarations

Inherited from AnyRef

Inherited from Any

Ungrouped