c

amf.plugins.document.webapi.contexts

RamlWebApiContext

abstract class RamlWebApiContext extends WebApiContext with RamlSpecAwareContext

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

Instance Constructors

  1. new RamlWebApiContext(loc: String, refs: Seq[ParsedReference], options: ParsingOptions, wrapped: ParserContext, ds: Option[RamlWebApiDeclarations] = None, parserCount: Option[Int] = None, eh: Option[ErrorHandler] = None, contextType: RamlWebApiContextType = RamlWebApiContextType.DEFAULT)

Abstract Value Members

  1. abstract def clone(declarations: RamlWebApiDeclarations): 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. def addSonRef(ref: BaseUnit): RamlWebApiContext.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 clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. def closedRamlTypeShape(shape: Shape, ast: YMap, shapeType: String, typeInfo: TypeInfo): 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

  10. def closedShape(node: String, ast: YMap, shape: String): Unit

    Validate closed shape.

    Validate closed shape.

    Definition Classes
    WebApiContext
  11. def computeJsonSchemaVersion(rootAst: YNode): JSONSchemaVersion
    Definition Classes
    WebApiContext
  12. var contextType: RamlWebApiContextType
  13. def copyWithSonsReferences(): ParserContext
    Definition Classes
    ParserContext
  14. val declarations: RamlWebApiDeclarations
    Definition Classes
    RamlWebApiContext → WebApiContext
  15. val eh: Option[ErrorHandler]
    Definition Classes
    RamlWebApiContext → WebApiContext → ParserContext
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def findDeclarations(path: Seq[String], declarations: RamlWebApiDeclarations): RamlWebApiDeclarations
    Attributes
    protected
  19. def findJsonSchema(url: String): Option[AnyShape]
    Definition Classes
    WebApiContext
  20. def findLocalJSONPath(path: String): Option[(String, YNode)]
    Definition Classes
    WebApiContext
  21. def forLocation(newLocation: String): ParserContext
    Definition Classes
    ParserContext
  22. val futureDeclarations: FutureDeclarations
    Definition Classes
    ParserContext
  23. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. var globalMediatype: Boolean
  25. var globalSpace: Map[String, Any]
    Definition Classes
    ParserContext
  26. def guiKey(message: String, location: Option[String], lexical: Option[LexicalInformation]): String
    Definition Classes
    ErrorHandler
  27. def handle(location: SourceLocation, e: SyamlException): Unit
    Definition Classes
    ErrorHandler → ParseErrorHandler
  28. final def handle(node: YPart, e: SyamlException): Unit
    Definition Classes
    ErrorHandler
  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. def mergeAllOperationContexts(): Unit
  36. def mergeContext(subContext: RamlWebApiContext): Unit
  37. def mergeOperationContext(operation: String): Unit
  38. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  39. def normalizedJsonPointer(url: String): String
    Attributes
    protected
    Definition Classes
    WebApiContext
  40. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  41. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  42. def obtainRemoteYNode(ref: String)(implicit ctx: WebApiContext): Option[YNode]
    Definition Classes
    WebApiContext
  43. val operationContexts: Map[String, RamlWebApiContext]
  44. val options: ParsingOptions
    Definition Classes
    WebApiContext
  45. def parseRemoteJSONPath(fileUrl: String)(implicit ctx: OasWebApiContext): Option[AnyShape]
    Definition Classes
    WebApiContext
  46. def parseRemoteOasParameter(fileUrl: String, parentId: String)(implicit ctx: OasWebApiContext): Option[OasParameter]
    Definition Classes
    WebApiContext
  47. val parserCount: Int
    Definition Classes
    ParserContext
  48. def part(error: YError): YPart
    Attributes
    protected
    Definition Classes
    ErrorHandler
  49. val platform: Platform
    Definition Classes
    PlatformSecrets
  50. val refs: Seq[ParsedReference]
    Definition Classes
    ParserContext
  51. def registerJsonSchema(url: String, shape: AnyShape): Unit
    Definition Classes
    WebApiContext
  52. def reportConstraint(id: String, node: String, property: Option[String], message: String, lexical: Option[LexicalInformation], level: String, location: Option[String]): Unit
    Definition Classes
    ParserContext → ErrorHandler
  53. var reportDisambiguation: Set[String]
    Definition Classes
    ParserContext
  54. def resolvedPath(base: String, str: String): String
    Definition Classes
    WebApiContext
  55. val rootContextDocument: String
    Definition Classes
    ParserContext
  56. def setJsonSchemaAST(value: YNode): Unit
    Definition Classes
    WebApiContext
  57. def supportsAnnotations: Boolean
    Attributes
    protected
  58. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  59. def violation(specification: ValidationSpecification, node: String, message: String): Unit
    Definition Classes
    ErrorHandler
  60. def violation(specification: ValidationSpecification, node: String, message: String, loc: SourceLocation): Unit
    Definition Classes
    ErrorHandler
  61. def violation(specification: ValidationSpecification, node: String, message: String, ast: YPart): Unit
    Definition Classes
    ErrorHandler
  62. def violation(spec: ValidationSpecification, n: String, prop: Option[String], msg: String, l: SourceLocation): Unit
    Definition Classes
    ErrorHandler
  63. def violation(spec: ValidationSpecification, node: String, prop: Option[String], msg: String, ast: YPart): Unit
    Definition Classes
    ErrorHandler
  64. def violation(specification: ValidationSpecification, node: String, message: String, location: String): Unit
    Definition Classes
    ErrorHandler
  65. def violation(specification: ValidationSpecification, element: AmfObject, target: Option[String], message: String): Unit
    Definition Classes
    ErrorHandler
  66. def violation(specification: ValidationSpecification, node: String, message: String, annotations: Annotations): Unit
    Definition Classes
    ErrorHandler
  67. def violation(specification: ValidationSpecification, node: String, property: Option[String], message: String, lexical: Option[LexicalInformation], location: Option[String]): Unit
    Definition Classes
    ErrorHandler
  68. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  69. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  70. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  71. def warning(specification: ValidationSpecification, node: String, message: String, annotations: Annotations): Unit
    Definition Classes
    ErrorHandler
  72. def warning(specification: ValidationSpecification, node: String, message: String, location: SourceLocation): Unit
    Definition Classes
    ErrorHandler
  73. def warning(specification: ValidationSpecification, node: String, message: String, ast: YPart): Unit
    Definition Classes
    ErrorHandler
  74. def warning(specification: ValidationSpecification, node: String, property: Option[String], message: String, part: YPart): Unit
    Definition Classes
    ErrorHandler
  75. def warning(specification: ValidationSpecification, node: String, property: Option[String], message: String, location: SourceLocation): Unit
    Definition Classes
    ErrorHandler
  76. def warning(spec: ValidationSpecification, element: AmfObject, target: Option[String], message: String): Unit
    Definition Classes
    ErrorHandler
  77. def warning(specification: ValidationSpecification, node: String, property: Option[String], message: String, lexical: Option[LexicalInformation], location: Option[String]): Unit
    Definition Classes
    ErrorHandler
  78. val wrapped: ParserContext

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