Packages

class WebApiDeclarations extends Declarations

Declarations object.

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

Instance Constructors

  1. new WebApiDeclarations(alias: Option[String], libs: Map[String, WebApiDeclarations] = Map(), frags: Map[String, FragmentRef] = Map(), shapes: Map[String, Shape] = Map(), anns: Map[String, CustomDomainProperty] = Map(), resourceTypes: Map[String, ResourceType] = Map(), parameters: Map[String, Parameter] = Map(), payloads: Map[String, Payload] = Map(), traits: Map[String, Trait] = Map(), securitySchemes: Map[String, SecurityScheme] = Map(), responses: Map[String, Response] = Map(), errorHandler: Option[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. val alias: Option[String]
  7. def aliased(name: String): String
  8. var annotations: Map[String, CustomDomainProperty]
    Definition Classes
    Declarations
  9. var anns: Map[String, CustomDomainProperty]
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def declarables(): Seq[DomainElement]
    Definition Classes
    WebApiDeclarations → Declarations
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def error(message: String, ast: YPart): Unit
    Attributes
    protected
    Definition Classes
    Declarations
  16. val errorHandler: Option[ErrorHandler]
  17. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def findAnnotation(key: String, scope: Scope): Option[CustomDomainProperty]
    Definition Classes
    Declarations
  19. def findAnnotationOrError(ast: YPart)(key: String, scope: Scope): CustomDomainProperty
    Definition Classes
    Declarations
  20. def findDocumentations(key: String, scope: Scope): Option[CreativeWork]
  21. def findEquivalent(element: DomainElement): Option[DomainElement]

    Find domain element with the same name.

    Find domain element with the same name.

    Definition Classes
    WebApiDeclarations → Declarations
  22. def findForType(key: String, map: (Declarations) ⇒ Map[String, DomainElement], scope: Scope): Option[DomainElement]
    Attributes
    protected
    Definition Classes
    Declarations
  23. def findNamedExample(key: String): Option[Example]
  24. def findNamedExampleOrError(ast: YPart)(key: String): Example
  25. def findParameter(key: String, scope: Scope): Option[Parameter]
  26. def findParameterOrError(ast: YPart)(key: String, scope: Scope): Parameter
  27. def findResourceType(key: String, scope: Scope): Option[ResourceType]
  28. def findResourceTypeOrError(ast: YPart)(key: String, scope: Scope): ResourceType
  29. def findResponse(key: String, scope: Scope): Option[Response]
  30. def findResponseOrError(ast: YPart)(key: String, searchScope: Scope): Response
  31. def findSecurityScheme(key: String, scope: Scope): Option[SecurityScheme]
  32. def findSecuritySchemeOrError(ast: YPart)(key: String, scope: Scope): SecurityScheme
  33. def findTraitOrError(ast: YPart)(key: String, scope: Scope): Trait
  34. def findType(key: String, scope: Scope): Option[AnyShape]
  35. var fragments: Map[String, FragmentRef]
    Definition Classes
    Declarations
  36. var frags: Map[String, FragmentRef]
  37. val futureDeclarations: FutureDeclarations
  38. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  39. def getOrCreateLibrary(alias: String): WebApiDeclarations

    Get or create specified library.

    Get or create specified library.

    Definition Classes
    WebApiDeclarations → Declarations
  40. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  41. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  42. var libraries: Map[String, Declarations]
    Definition Classes
    Declarations
  43. var libs: Map[String, WebApiDeclarations]
  44. def merge(other: WebApiDeclarations): WebApiDeclarations
  45. def mergeParts(other: WebApiDeclarations, merged: WebApiDeclarations): Unit
    Attributes
    protected
  46. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  47. final def notify(): Unit
    Definition Classes
    AnyRef
  48. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  49. def parameterPayload(parameter: Parameter): Payload
  50. var parameters: Map[String, Parameter]
  51. var payloads: Map[String, Payload]
  52. def registerParameter(parameter: Parameter, payload: Payload): Unit
  53. var resourceTypes: Map[String, ResourceType]
  54. var responses: Map[String, Response]
  55. var securitySchemes: Map[String, SecurityScheme]
  56. var shapes: Map[String, Shape]
  57. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  58. def toString(): String
    Definition Classes
    AnyRef → Any
  59. var traits: Map[String, Trait]
  60. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  61. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Declarations

Inherited from AnyRef

Inherited from Any

Ungrouped