c

amf.plugins.document.webapi.contexts

Raml08WebApiContext

class Raml08WebApiContext extends RamlWebApiContext

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

Instance Constructors

  1. new Raml08WebApiContext(loc: String, refs: Seq[ParsedReference], wrapped: ParserContext, ds: Option[RamlWebApiDeclarations] = None, eh: Option[ErrorHandler] = None)

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

    Definition Classes
    RamlWebApiContext
  5. def addSonRef(ref: BaseUnit): Raml08WebApiContext.this.type
    Definition Classes
    ParserContext
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def basePath(path: String): String
    Definition Classes
    WebApiContext
  8. def checkDuplicates(node: String, ast: YMap, shape: String, annotation: Boolean): Set[String]
    Definition Classes
    WebApiContext
  9. def clone(declarations: RamlWebApiDeclarations): RamlWebApiContext
    Attributes
    protected
    Definition Classes
    Raml08WebApiContext → RamlWebApiContext
  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  11. 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

    Definition Classes
    RamlWebApiContext
  12. def closedShape(node: String, ast: YMap, shape: String, annotation: Boolean = false): Unit

    Validate closed shape.

    Validate closed shape.

    Definition Classes
    WebApiContext
  13. def computeJsonSchemaVersion(rootAst: YNode): JSONSchemaVersion
    Definition Classes
    WebApiContext
  14. def copyWithSonsReferences(): ParserContext
    Definition Classes
    ParserContext
  15. val declarations: RamlWebApiDeclarations
    Definition Classes
    RamlWebApiContext → WebApiContext
  16. val eh: Option[ErrorHandler]
    Definition Classes
    Raml08WebApiContext → RamlWebApiContext → WebApiContext → ParserContext
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. val factory: RamlSpecVersionFactory
    Definition Classes
    Raml08WebApiContext → RamlWebApiContext → SpecAwareContext
  19. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. def findDeclarations(path: Seq[String], declarations: RamlWebApiDeclarations): RamlWebApiDeclarations
    Attributes
    protected
    Definition Classes
    RamlWebApiContext
  21. def findJsonSchema(url: String): Option[AnyShape]
    Definition Classes
    WebApiContext
  22. def findLocalJSONPath(path: String): Option[(String, YNode)]
    Definition Classes
    WebApiContext
  23. def forLocation(newLocation: String): ParserContext
    Definition Classes
    ParserContext
  24. val futureDeclarations: FutureDeclarations
    Definition Classes
    ParserContext
  25. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. var globalMediatype: Boolean
    Definition Classes
    RamlWebApiContext
  27. var globalSpace: Map[String, Any]
    Definition Classes
    ParserContext
  28. def handle(node: YPart, e: SyamlException): Unit
    Definition Classes
    ErrorHandler → ParseErrorHandler
  29. def handle[T](error: YError, defaultValue: T): T
    Definition Classes
    ErrorHandler → IllegalTypeHandler
  30. def ignore(shape: String, property: String): Boolean
    Definition Classes
    RamlWebApiContext → WebApiContext
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. def link(node: YNode): Either[String, YNode]
    Definition Classes
    RamlWebApiContext → WebApiContext
  33. val loc: String
    Definition Classes
    RamlWebApiContext → WebApiContext
  34. var localJSONSchemaContext: Option[YNode]
    Definition Classes
    WebApiContext
  35. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. def normalizedJsonPointer(url: String): String
    Attributes
    protected
    Definition Classes
    WebApiContext
  37. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  38. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  39. def parseRemoteJSONPath(fileUrl: String)(implicit ctx: OasWebApiContext): Option[AnyShape]
    Definition Classes
    WebApiContext
  40. def parseRemoteOasParameter(fileUrl: String, parentId: String)(implicit ctx: OasWebApiContext): Option[OasParameter]
    Definition Classes
    WebApiContext
  41. val parserCount: Int
    Definition Classes
    ParserContext
  42. def part(error: YError): YPart
    Attributes
    protected
    Definition Classes
    ErrorHandler
  43. val platform: Platform
    Definition Classes
    PlatformSecrets
  44. val refs: Seq[ParsedReference]
    Definition Classes
    ParserContext
  45. def registerJsonSchema(url: String, shape: AnyShape): Unit
    Definition Classes
    WebApiContext
  46. def reportConstraint(id: String, node: String, property: Option[String], message: String, lexical: Option[LexicalInformation], level: String, location: Option[String]): Unit
    Definition Classes
    ParserContext → ErrorHandler
  47. def resolvedPath(base: String, str: String): String
    Definition Classes
    WebApiContext
  48. val rootContextDocument: String
    Definition Classes
    ParserContext
  49. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  50. val syntax: SpecSyntax
    Definition Classes
    Raml08WebApiContext → WebApiContext
  51. val vendor: Vendor
    Definition Classes
    Raml08WebApiContext → WebApiContext
  52. def violation(node: String, message: String): Unit
    Definition Classes
    ParserContext
  53. def violation(node: String, message: String, lexical: Option[LexicalInformation], location: Option[String]): Unit
    Definition Classes
    ErrorHandler
  54. def violation(node: String, message: String, location: String): Unit
    Definition Classes
    ErrorHandler
  55. def violation(node: String, message: String, ast: YPart): Unit
    Definition Classes
    ErrorHandler
  56. def violation(id: String, node: String, message: String, ast: YPart): Unit
    Definition Classes
    ErrorHandler
  57. def violation(id: String, node: String, property: Option[String], message: String, ast: YPart): Unit
    Definition Classes
    ErrorHandler
  58. def violation(message: String, ast: YPart): Unit
    Definition Classes
    ErrorHandler
  59. def violation(id: String, element: AmfObject, target: Option[String], message: String): Unit
    Definition Classes
    ErrorHandler
  60. def violation(id: String, node: String, message: String, annotations: Annotations): Unit
    Definition Classes
    ErrorHandler
  61. def violation(id: String, node: String, property: Option[String], message: String, lexical: Option[LexicalInformation], location: Option[String]): Unit
    Definition Classes
    ErrorHandler
  62. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  64. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  65. def warning(id: String, node: String, message: String, annotations: Annotations): Unit
    Definition Classes
    ErrorHandler
  66. def warning(node: String, message: String, ast: YPart): Unit
    Definition Classes
    ErrorHandler
  67. def warning(id: String, node: String, message: String, ast: YPart): Unit
    Definition Classes
    ErrorHandler
  68. def warning(id: String, node: String, property: Option[String], message: String, ast: YPart): Unit
    Definition Classes
    ErrorHandler
  69. def warning(message: String, ast: YPart): Unit
    Definition Classes
    ErrorHandler
  70. def warning(id: String, element: AmfObject, target: Option[String], message: String): Unit
    Definition Classes
    ErrorHandler
  71. def warning(id: String, node: String, property: Option[String], message: String, lexical: Option[LexicalInformation], location: Option[String]): Unit
    Definition Classes
    ErrorHandler

Inherited from RamlWebApiContext

Inherited from RamlSpecAwareContext

Inherited from WebApiContext

Inherited from PlatformSecrets

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