Packages

class PayloadContext extends RamlWebApiContext

Linear Supertypes
RamlWebApiContext, RamlSpecAwareContext, WebApiContext, IllegalTypeHandler, ParseErrorHandler, JsonSchemaInference, PlatformSecrets, SpecAwareContext, DeclarationContext, ExtensionsContext, DataNodeParserContext, ParserContext, Serializable, Serializable, Product, Equals, UnresolvedComponents, ErrorHandlingContext, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PayloadContext
  2. RamlWebApiContext
  3. RamlSpecAwareContext
  4. WebApiContext
  5. IllegalTypeHandler
  6. ParseErrorHandler
  7. JsonSchemaInference
  8. PlatformSecrets
  9. SpecAwareContext
  10. DeclarationContext
  11. ExtensionsContext
  12. DataNodeParserContext
  13. ParserContext
  14. Serializable
  15. Serializable
  16. Product
  17. Equals
  18. UnresolvedComponents
  19. ErrorHandlingContext
  20. AnyRef
  21. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

Type Members

  1. case class WebApiSemanticExtensionsFacadeBuilder(annotationSchemaValidatorBuilder: AnnotationSchemaValidatorBuilder) extends SemanticExtensionsFacadeBuilder with Product with Serializable
    Definition Classes
    WebApiContext

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from PayloadContext to any2stringadd[PayloadContext] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (PayloadContext, B)
    Implicit
    This member is added by an implicit conversion from PayloadContext to ArrowAssoc[PayloadContext] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. 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
  7. def addSonRef(ref: BaseUnit): PayloadContext.this.type
    Definition Classes
    ParserContext
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def autoGeneratedAnnotation(s: Shape): Unit
    Definition Classes
    RamlWebApiContext → WebApiContext
  10. def clone(declarations: RamlWebApiDeclarations): RamlWebApiContext
    Attributes
    protected
    Definition Classes
    PayloadContext → RamlWebApiContext
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  12. 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

    Definition Classes
    RamlWebApiContext
  13. def closedShape(node: AmfObject, ast: YMap, shape: String, syntax: SpecSyntax): Unit
    Attributes
    protected
    Definition Classes
    WebApiContext
  14. def closedShape(node: AmfObject, ast: YMap, shape: String): Unit

    Validate closed shape.

    Validate closed shape.

    Definition Classes
    WebApiContext
  15. def computeJsonSchemaVersion(ast: YNode): SchemaVersion
    Definition Classes
    WebApiContext
  16. val config: ParseConfiguration
    Definition Classes
    ParserContext
  17. var contextType: RamlWebApiContextType
    Definition Classes
    RamlWebApiContext
  18. def copyWithSonsReferences(): ParserContext
    Definition Classes
    ParserContext
  19. val declarations: RamlWebApiDeclarations
    Definition Classes
    RamlWebApiContext → DeclarationContext → ExtensionsContext
  20. val declarationsOption: Option[WebApiDeclarations]
    Definition Classes
    ExtensionsContext
  21. val defaultSchemaVersion: SchemaVersion
    Definition Classes
    WebApiContext → JsonSchemaInference
  22. implicit val eh: AMFErrorHandler
    Definition Classes
    ErrorHandlingContext
  23. def ensuring(cond: (PayloadContext) ⇒ Boolean, msg: ⇒ Any): PayloadContext
    Implicit
    This member is added by an implicit conversion from PayloadContext to Ensuring[PayloadContext] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. def ensuring(cond: (PayloadContext) ⇒ Boolean): PayloadContext
    Implicit
    This member is added by an implicit conversion from PayloadContext to Ensuring[PayloadContext] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. def ensuring(cond: Boolean, msg: ⇒ Any): PayloadContext
    Implicit
    This member is added by an implicit conversion from PayloadContext to Ensuring[PayloadContext] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  26. def ensuring(cond: Boolean): PayloadContext
    Implicit
    This member is added by an implicit conversion from PayloadContext to Ensuring[PayloadContext] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  27. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. val extensionsFacadeBuilder: SemanticExtensionsFacadeBuilder
    Definition Classes
    WebApiContext
  29. val factory: RamlSpecVersionFactory
    Definition Classes
    PayloadContext → RamlWebApiContext → SpecAwareContext
  30. def findAnnotation(key: String, scope: Scope): Option[CustomDomainProperty]
    Definition Classes
    ExtensionsContext → DataNodeParserContext
  31. def findDeclarations(path: Seq[String], declarations: RamlWebApiDeclarations): RamlWebApiDeclarations
    Attributes
    protected
    Definition Classes
    RamlWebApiContext
  32. def findJsonPathIn(index: AstIndex, path: String): Option[YMapEntryLike]
    Definition Classes
    WebApiContext
  33. def findJsonSchema(url: String): Option[AnyShape]
    Definition Classes
    WebApiContext
  34. def findLocalJSONPath(path: String): Option[YMapEntryLike]
    Definition Classes
    WebApiContext
  35. def forLocation(newLocation: String): ParserContext
    Definition Classes
    ParserContext
  36. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from PayloadContext to StringFormat[PayloadContext] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  37. def fragments: Map[String, FragmentRef]
    Definition Classes
    ExtensionsContext → DataNodeParserContext
  38. val futureDeclarations: FutureDeclarations
    Definition Classes
    ParserContext → UnresolvedComponents
  39. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  40. def getEntryKey(entry: YMapEntry): String
    Definition Classes
    WebApiContext
  41. def getMaxYamlReferences: Option[Int]
    Definition Classes
    ExtensionsContext → DataNodeParserContext
  42. var globalMediatype: Boolean
    Definition Classes
    RamlWebApiContext
  43. var globalSpace: Map[String, Any]
    Definition Classes
    ParserContext
  44. def handle(location: SourceLocation, e: SyamlException): Unit
    Definition Classes
    WebApiContext → ParseErrorHandler
  45. def handle[T](error: YError, defaultValue: T): T
    Definition Classes
    WebApiContext → IllegalTypeHandler
  46. def ignore(shape: String, property: String): Boolean
    Definition Classes
    RamlWebApiContext → WebApiContext
  47. var indexCache: Map[String, AstIndex]
    Definition Classes
    WebApiContext
  48. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  49. var jsonSchemaRefGuide: JsonSchemaRefGuide
    Definition Classes
    WebApiContext
  50. def link(node: YNode): Either[String, YNode]
    Definition Classes
    RamlWebApiContext → WebApiContext
  51. val loc: String
    Definition Classes
    RamlWebApiContext → ExtensionsContext
  52. var localJSONSchemaContext: Option[YNode]
    Definition Classes
    WebApiContext
  53. def mergeAllOperationContexts(): Unit
    Definition Classes
    RamlWebApiContext
  54. def mergeContext(subContext: RamlWebApiContext): Unit
    Definition Classes
    RamlWebApiContext
  55. def mergeOperationContext(operation: AmfObject): Unit
    Definition Classes
    RamlWebApiContext
  56. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  57. def nextValidation(node: AmfObject, shape: String, ast: YMap): Unit
    Attributes
    protected
    Definition Classes
    WebApiContext
  58. val nodeRefIds: Map[YNode, String]
    Definition Classes
    ExtensionsContext
  59. def normalizedJsonPointer(url: String): String
    Attributes
    protected
    Definition Classes
    WebApiContext
  60. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  61. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  62. def obtainRemoteYNode(ref: String, refAnnotations: Annotations = Annotations())(implicit ctx: WebApiContext): Option[YNode]
    Definition Classes
    WebApiContext
  63. val operationContexts: Map[AmfObject, RamlWebApiContext]
    Definition Classes
    RamlWebApiContext
  64. val options: ParsingOptions
    Definition Classes
    ExtensionsContext
  65. def parseSchemaVersion(ast: YNode, errorHandler: AMFErrorHandler): SchemaVersion
    Definition Classes
    JsonSchemaInference
  66. def parsingOptions: ParsingOptions
    Definition Classes
    ParserContext
  67. val platform: Platform
    Definition Classes
    PlatformSecrets
  68. val refs: Seq[ParsedReference]
    Definition Classes
    ParserContext
  69. def registerJsonSchema(url: String, shape: AnyShape): Unit
    Definition Classes
    WebApiContext
  70. val rootContextDocument: String
    Definition Classes
    ParserContext
  71. def setJsonSchemaAST(value: YNode): Unit
    Definition Classes
    WebApiContext
  72. val spec: Spec
    Definition Classes
    PayloadContext → WebApiContext
  73. def supportsAnnotations: Boolean
    Attributes
    protected
    Definition Classes
    RamlWebApiContext
  74. val syamleh: SyamlAMFErrorHandler
    Definition Classes
    WebApiContext
  75. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  76. val syntax: SpecSyntax
    Definition Classes
    PayloadContext → WebApiContext
  77. def throwClosedShapeError(node: AmfObject, message: String, entry: YPart, isWarning: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    WebApiContext
  78. def validateRefFormatWithError(ref: String): Boolean
    Definition Classes
    WebApiContext
  79. def violation(violationId: ValidationSpecification, node: AmfObject, message: String): Unit
    Definition Classes
    ParserContext → ErrorHandlingContext
  80. def violation(violationId: ValidationSpecification, node: String, message: String): Unit
    Definition Classes
    ParserContext → ErrorHandlingContext
  81. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  82. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  83. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  84. val wrapped: ParserContext
    Definition Classes
    PayloadContext → RamlWebApiContext
  85. def →[B](y: B): (PayloadContext, B)
    Implicit
    This member is added by an implicit conversion from PayloadContext to ArrowAssoc[PayloadContext] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from RamlWebApiContext

Inherited from RamlSpecAwareContext

Inherited from WebApiContext

Inherited from IllegalTypeHandler

Inherited from ParseErrorHandler

Inherited from JsonSchemaInference

Inherited from PlatformSecrets

Inherited from SpecAwareContext

Inherited from DeclarationContext

Inherited from ExtensionsContext

Inherited from DataNodeParserContext

Inherited from ParserContext

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from UnresolvedComponents

Inherited from ErrorHandlingContext

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from PayloadContext to any2stringadd[PayloadContext]

Inherited by implicit conversion StringFormat from PayloadContext to StringFormat[PayloadContext]

Inherited by implicit conversion Ensuring from PayloadContext to Ensuring[PayloadContext]

Inherited by implicit conversion ArrowAssoc from PayloadContext to ArrowAssoc[PayloadContext]

Ungrouped