c

amf.plugins.document.webapi.contexts

RamlWebApiContext

abstract class RamlWebApiContext extends WebApiContext with RamlSpecAwareContext

Linear Supertypes
RamlSpecAwareContext, WebApiContext, SpecAwareContext, ParserContext, Serializable, Serializable, Product, Equals, ErrorHandler, ParseErrorHandler, IllegalTypeHandler, AnyRef, Any
Known Subclasses
PayloadContext, Raml08WebApiContext, Raml10WebApiContext, CustomRaml08WebApiContext, CustomRaml10WebApiContext
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RamlWebApiContext
  2. RamlSpecAwareContext
  3. WebApiContext
  4. SpecAwareContext
  5. ParserContext
  6. Serializable
  7. Serializable
  8. Product
  9. Equals
  10. ErrorHandler
  11. ParseErrorHandler
  12. IllegalTypeHandler
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RamlWebApiContext(wrapped: ParserContext, ds: Option[WebApiDeclarations] = None)

Abstract Value Members

  1. abstract def clone(declarations: WebApiDeclarations): RamlWebApiContext
    Attributes
    protected
  2. abstract val factory: RamlSpecVersionFactory
    Definition Classes
    RamlWebApiContext → SpecAwareContext
  3. abstract val syntax: SpecSyntax
    Definition Classes
    WebApiContext
  4. abstract val vendor: Vendor
    Definition Classes
    WebApiContext

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def adapt[T](path: String)(k: (RamlWebApiContext) ⇒ T): T

    Adapt this context for a nested library, used when evaluating resource type / traits Using a path to the library whose context is going to be looked up, e.g.

    Adapt this context for a nested library, used when evaluating resource type / traits Using a path to the library whose context is going to be looked up, e.g. lib.TypeA

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def checkDuplicates(node: String, ast: YMap, shape: String, annotation: Boolean): Set[String]
    Definition Classes
    WebApiContext
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def closedRamlTypeShape(shape: Shape, ast: YMap, shapeType: String, annotation: Boolean = false): Unit

    raml types nodes are different from other shapes because they can have 'custom facets' essentially, client defined constraints expressed as additional properties syntactically in the type definition.

    raml types nodes are different from other shapes because they can have 'custom facets' essentially, client defined constraints expressed as additional properties syntactically in the type definition. The problem is that they cannot be recognised just looking into the AST as we do with annotations, so we need to first, compute them, and then, add them as additional valid properties to the set of properties that can be defined in the AST node

  9. def closedShape(node: String, ast: YMap, shape: String, annotation: Boolean = false): Unit

    Validate closed shape.

    Validate closed shape.

    Definition Classes
    WebApiContext
  10. val currentFile: String
    Definition Classes
    ParserContext → ErrorHandler
  11. val declarations: WebApiDeclarations
    Definition Classes
    WebApiContext
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. def findDeclarations(path: Seq[String], declarations: WebApiDeclarations): WebApiDeclarations
    Attributes
    protected
  15. def findLocalJSONPath(path: String): Option[(String, YNode)]
    Definition Classes
    WebApiContext
  16. val futureDeclarations: FutureDeclarations
    Definition Classes
    ParserContext
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  18. var globalMediatype: Boolean
  19. def handle(node: YPart, e: SyamlException): Unit
    Definition Classes
    ErrorHandler → ParseErrorHandler
  20. def handle[T](error: YError, defaultValue: T): T
    Definition Classes
    ErrorHandler → IllegalTypeHandler
  21. def ignore(shape: String, property: String): Boolean
    Definition Classes
    RamlWebApiContext → WebApiContext
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def link(node: YNode): Either[String, YNode]
    Definition Classes
    RamlWebApiContext → WebApiContext
  24. var localJSONSchemaContext: Option[YNode]
    Definition Classes
    WebApiContext
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  28. val parserCount: Int
    Definition Classes
    ParserContext → ErrorHandler
  29. def part(error: YError): YPart
    Attributes
    protected
    Definition Classes
    ErrorHandler
  30. val refs: Seq[ParsedReference]
    Definition Classes
    ParserContext
  31. val rootContextDocument: String
    Definition Classes
    ParserContext
  32. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  33. def violation(node: String, message: String, ast: YPart): Unit
    Definition Classes
    ErrorHandler
  34. def violation(id: String, node: String, message: String, ast: YPart): Unit
    Definition Classes
    ErrorHandler
  35. def violation(id: String, node: String, property: Option[String], message: String, ast: YPart): Unit
    Definition Classes
    ErrorHandler
  36. def violation(message: String, ast: YPart): Unit
    Definition Classes
    ErrorHandler
  37. def violation(id: String, node: String, property: Option[String], message: String, lexical: Option[LexicalInformation]): Unit
    Definition Classes
    ErrorHandler
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. def warning(node: String, message: String, ast: YPart): Unit
    Definition Classes
    ErrorHandler
  42. def warning(id: String, node: String, message: String, ast: YPart): Unit
    Definition Classes
    ErrorHandler
  43. def warning(id: String, node: String, property: Option[String], message: String, ast: YPart): Unit
    Definition Classes
    ErrorHandler
  44. def warning(message: String, ast: YPart): Unit
    Definition Classes
    ErrorHandler
  45. def warning(id: String, node: String, property: Option[String], message: String, lexical: Option[LexicalInformation]): Unit
    Definition Classes
    ErrorHandler

Inherited from RamlSpecAwareContext

Inherited from WebApiContext

Inherited from SpecAwareContext

Inherited from ParserContext

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ErrorHandler

Inherited from ParseErrorHandler

Inherited from IllegalTypeHandler

Inherited from AnyRef

Inherited from Any

Ungrouped