case class SchemaShape(fields: Fields, annotations: Annotations) extends AnyShape with ExternalSourceElement with Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyShape, InheritanceChain, ExternalSourceElement, RamlDatatypeSerializer, JsonSchemaSerializer, ShapeHelpers, JsonSchemaSecrets, Shape, NamedDomainElement, Linkable, DomainElement, AmfObject, AmfElement, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SchemaShape
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyShape
  7. InheritanceChain
  8. ExternalSourceElement
  9. RamlDatatypeSerializer
  10. JsonSchemaSerializer
  11. ShapeHelpers
  12. JsonSchemaSecrets
  13. Shape
  14. NamedDomainElement
  15. Linkable
  16. DomainElement
  17. AmfObject
  18. AmfElement
  19. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SchemaShape(fields: Fields, annotations: Annotations)

Type Members

  1. type FacetsMap = Map[String, PropertyShape]
    Definition Classes
    Shape

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 add(field: Field, value: AmfElement): SchemaShape.this.type
    Definition Classes
    AmfObject
  5. def add(other: Annotations): SchemaShape.this.type
    Definition Classes
    AmfElement
  6. def add(annotation: Annotation): SchemaShape.this.type
    Definition Classes
    AmfElement
  7. def addSubType(shape: Shape): Unit
    Definition Classes
    InheritanceChain
  8. def addSuperType(shape: Shape): Unit
    Definition Classes
    InheritanceChain
  9. def adopted(parent: String, cycle: Seq[String]): SchemaShape.this.type
    Definition Classes
    AmfObject
  10. def afterResolve(fatherSyntaxKey: Option[String], resolvedId: String): Unit
    Definition Classes
    Linkable
  11. def and: Seq[Shape]
    Definition Classes
    Shape
  12. val annotations: Annotations
    Definition Classes
    SchemaShapeAnyShape → AmfElement
  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. def buildFixPoint(id: Option[String], name: String, link: Linkable, recursionErrorHandler: Option[ErrorHandler]): RecursiveShape
    Attributes
    protected
    Definition Classes
    ShapeHelpers
  15. def buildJsonSchema(): String
    Definition Classes
    AnyShape
  16. def buildRamlDatatype(): String

    Generates a new RAML Data Type.

    Generates a new RAML Data Type.

    Definition Classes
    AnyShape
  17. def classConstructor: (Fields, Annotations) ⇒ Linkable with DomainElement

    apply method for create a new instance with fields and annotations.

    apply method for create a new instance with fields and annotations. Aux method for copy

    Attributes
    protected
    Definition Classes
    SchemaShapeAnyShape → Linkable
  18. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  19. def cloneAllExamples(cloned: Shape, s: Shape): Unit
    Definition Classes
    ShapeHelpers
  20. def cloneShape(recursionErrorHandler: Option[ErrorHandler], withRecursionBase: Option[String] = None, traversed: IdsTraversionCheck = IdsTraversionCheck(), cloneExamples: Boolean = false): SchemaShape.this.type
    Definition Classes
    ShapeHelpers
  21. val closureShapes: Set[Shape]
    Definition Classes
    Shape
  22. def collectCustomShapePropertyDefinitions(onlyInherited: Boolean, traversed: Set[String]): Seq[FacetsMap]
    Definition Classes
    Shape
  23. def componentId: String

    Value , path + field value that is used to compose the id when the object its adopted

    Value , path + field value that is used to compose the id when the object its adopted

    Definition Classes
    SchemaShapeAnyShape → AmfObject
  24. def computeSubtypesClosure(): Seq[Shape]
    Attributes
    protected
    Definition Classes
    InheritanceChain
  25. def copyAnyShape(fields: Fields = fields, annotations: Annotations = annotations): AnyShape
    Definition Classes
    AnyShape
  26. def copyElement(a: Annotations): Linkable with DomainElement
    Definition Classes
    Linkable
  27. def copyElement(): Linkable with DomainElement
    Definition Classes
    Linkable
  28. def copyFields(recursionErrorHandler: Option[ErrorHandler], cloned: Shape, recursionBase: Option[String], traversed: IdsTraversionCheck): Unit
    Attributes
    protected
    Definition Classes
    Shape
  29. def copyShape(): SchemaShape.this.type
    Definition Classes
    AnyShape → Shape
  30. def copyShape(a: Annotations): SchemaShape.this.type
    Definition Classes
    Shape
  31. def customDomainProperties: Seq[DomainExtension]
    Definition Classes
    DomainElement
  32. def customShapeProperties: Seq[ShapeExtension]
    Definition Classes
    Shape
  33. def customShapePropertyDefinitions: Seq[PropertyShape]
    Definition Classes
    Shape
  34. def default: DataNode
    Definition Classes
    Shape
  35. def defaultString: StrField
    Definition Classes
    Shape
  36. def description: StrField
    Definition Classes
    Shape
  37. def displayName: StrField
    Definition Classes
    Shape
  38. def documentation: CreativeWork
    Definition Classes
    AnyShape
  39. def effectiveInherits: Seq[Shape]
    Definition Classes
    Shape
  40. def effectiveLinkTarget(links: Seq[String]): DomainElement
    Definition Classes
    Linkable
  41. def effectiveStructuralShapes: Seq[Shape]
    Definition Classes
    InheritanceChain
  42. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  43. def examples: Seq[Example]
    Definition Classes
    AnyShape
  44. def extend: Seq[DomainElement]
    Definition Classes
    DomainElement
  45. def externalSourceID: Option[String]
    Definition Classes
    ShapeHelpers
  46. val fields: Fields
    Definition Classes
    SchemaShapeAnyShape → AmfObject
  47. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  48. def fromExternalSource: Boolean
    Definition Classes
    ShapeHelpers
  49. def fromLocal(): Boolean
    Definition Classes
    AmfElement
  50. def fromTypeExpression: Boolean
    Definition Classes
    ShapeHelpers
  51. def generateJsonSchema(element: AnyShape): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  52. def generateRamlDatatype(element: AnyShape): String

    Generates a new RAML Data Type included in RAML 1.0 Library.

    Generates a new RAML Data Type included in RAML 1.0 Library.

    Attributes
    protected
    Definition Classes
    RamlDatatypeSerializer
  53. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  54. lazy val graph: Graph
    Definition Classes
    DomainElement
  55. val id: String
    Definition Classes
    AmfObject
  56. val inheritedIds: Seq[String]
    Definition Classes
    InheritanceChain
  57. def inherits: Seq[Shape]
    Definition Classes
    Shape
  58. def inlined: Boolean
    Attributes
    protected
    Definition Classes
    AnyShape
  59. def isDefaultEmpty: Boolean

    Aux method to know when the shape is instance only of any shape and it's because was parsed from an empty (or only with example) payload, an not an explicit type def

    Aux method to know when the shape is instance only of any shape and it's because was parsed from an empty (or only with example) payload, an not an explicit type def

    Definition Classes
    AnyShape
  60. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  61. def isLink: Boolean
    Definition Classes
    Linkable
  62. def isLinkToSource: Boolean
    Definition Classes
    ExternalSourceElement
  63. def isTrackedBy(trackId: String): Boolean
    Definition Classes
    AmfElement
  64. val isUnresolved: Boolean
    Definition Classes
    Linkable
  65. def link[T](label: String, annotations: Annotations): T
    Definition Classes
    Linkable
  66. val linkAnnotations: Option[Annotations]
    Definition Classes
    Linkable
  67. def linkCopy(): SchemaShape
    Definition Classes
    SchemaShapeAnyShape → Linkable
  68. def linkLabel: StrField
    Definition Classes
    Linkable
  69. def linkSubType(shape: AnyShape): Unit
    Definition Classes
    InheritanceChain
  70. def linkTarget: Option[DomainElement]
    Definition Classes
    Linkable
  71. def location(): Option[String]
    Definition Classes
    ExternalSourceElement → AmfElement
  72. def mediaType: StrField
  73. def meta: SchemaShapeModel
    Definition Classes
    SchemaShapeAnyShape → AmfObject
  74. def name: StrField
    Definition Classes
    NamedDomainElement
  75. def nameField: Field
    Attributes
    protected
    Definition Classes
    Shape → NamedDomainElement
  76. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  77. def not: Shape
    Definition Classes
    Shape
  78. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  79. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  80. def or: Seq[Shape]
    Definition Classes
    Shape
  81. def parameterValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  82. def payloadValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  83. def payloadValidator(shape: Shape, validationMode: ValidationMode): PlatformPayloadValidator
    Attributes
    protected
    Definition Classes
    JsonSchemaSecrets
  84. def position(): Option[LexicalInformation]
    Definition Classes
    AmfElement
  85. def ramlSyntaxKey: String
    Definition Classes
    SchemaShapeAnyShape → Shape
  86. def raw: StrField
    Definition Classes
    ExternalSourceElement
  87. val refAst: Option[YPart]
    Definition Classes
    Linkable
  88. val refCtx: Option[ParserContext]
    Definition Classes
    Linkable
  89. val refName: String
    Definition Classes
    Linkable
  90. def referenceId: StrField
    Definition Classes
    ExternalSourceElement
  91. def resolveUnreferencedLink[T](label: String, annotations: Annotations, unresolved: T, supportsRecursion: Boolean): T
    Definition Classes
    Linkable
  92. def set(field: Field, value: AmfElement, annotations: Annotations): SchemaShape.this.type
    Definition Classes
    AmfObject
  93. def set(field: Field, value: AmfElement): SchemaShape.this.type
    Definition Classes
    AmfObject
  94. def set(field: Field, values: Seq[String]): SchemaShape.this.type
    Definition Classes
    AmfObject
  95. def set(field: Field, value: Float): SchemaShape.this.type
    Definition Classes
    AmfObject
  96. def set(field: Field, value: Double): SchemaShape.this.type
    Definition Classes
    AmfObject
  97. def set(field: Field, value: Int): SchemaShape.this.type
    Definition Classes
    AmfObject
  98. def set(field: Field, value: Boolean): SchemaShape.this.type
    Definition Classes
    AmfObject
  99. def set(field: Field, value: String): SchemaShape.this.type
    Definition Classes
    AmfObject
  100. def setArray(field: Field, values: Seq[AmfElement], annotations: Annotations): SchemaShape.this.type
    Definition Classes
    AmfObject
  101. def setArray(field: Field, values: Seq[AmfElement]): SchemaShape.this.type
    Definition Classes
    AmfObject
  102. def setArrayWithoutId(field: Field, values: Seq[AmfElement], annotations: Annotations): SchemaShape.this.type
    Definition Classes
    AmfObject
  103. def setArrayWithoutId(field: Field, values: Seq[AmfElement]): SchemaShape.this.type
    Definition Classes
    AmfObject
  104. val shouldLink: Boolean
    Attributes
    protected
    Definition Classes
    Linkable
  105. final def simpleAdoption(parent: String): SchemaShape.this.type
    Definition Classes
    AmfObject
  106. val subTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  107. val superTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  108. def supportsRecursion: BoolField
    Definition Classes
    Linkable
  109. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  110. def toFutureRef(resolve: (Linkable) ⇒ Unit): Unit
    Definition Classes
    Linkable
  111. def toJsonSchema: String
    Definition Classes
    AnyShape
  112. def toJsonSchema(element: AnyShape): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  113. def toRamlDatatype: String

    Delegates generation of a new RAML Data Type or returns cached one if it was generated before.

    Delegates generation of a new RAML Data Type or returns cached one if it was generated before.

    Definition Classes
    AnyShape
  114. def toRamlDatatype(element: AnyShape): String

    Delegates generation of a new RAML Data Type or returns cached one if it was generated before.

    Delegates generation of a new RAML Data Type or returns cached one if it was generated before.

    Attributes
    protected
    Definition Classes
    RamlDatatypeSerializer
  115. def trackedExample(trackId: String): Option[Example]
    Definition Classes
    AnyShape
  116. def typeExpression(eh: ErrorHandler): String
    Definition Classes
    ShapeHelpers
  117. def unresolved(refName: String, refAst: YPart, unresolvedSeverity: String)(implicit ctx: ParserContext): DomainElement with Linkable
    Definition Classes
    Linkable
  118. val unresolvedSeverity: String
    Definition Classes
    Linkable
  119. def validate(fragment: PayloadFragment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  120. def validate(fragment: PayloadFragment, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  121. def validate(payload: String): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  122. def validate(payload: String, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  123. def validateParameter(payload: String): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  124. def validateParameter(payload: String, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  125. def values: Seq[DataNode]
    Definition Classes
    Shape
  126. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  127. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  128. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  129. def withAnd(subShapes: Seq[Shape]): SchemaShape.this.type
    Definition Classes
    Shape
  130. def withCustomDomainProperties(extensions: Seq[DomainExtension]): SchemaShape.this.type
    Definition Classes
    DomainElement
  131. def withCustomDomainProperty(extensions: DomainExtension): SchemaShape.this.type
    Definition Classes
    DomainElement
  132. def withCustomShapeProperties(properties: Seq[ShapeExtension]): SchemaShape.this.type
    Definition Classes
    Shape
  133. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  134. def withCustomShapePropertyDefinitions(propertyDefinitions: Seq[PropertyShape]): SchemaShape.this.type
    Definition Classes
    Shape
  135. def withDefault(default: DataNode): SchemaShape.this.type
    Definition Classes
    Shape
  136. def withDefaultStr(value: String): SchemaShape.this.type
    Definition Classes
    Shape
  137. def withDescription(description: String): SchemaShape.this.type
    Definition Classes
    Shape
  138. def withDisplayName(name: String): SchemaShape.this.type
    Definition Classes
    Shape
  139. def withDocumentation(documentation: CreativeWork): SchemaShape.this.type
    Definition Classes
    AnyShape
  140. def withExample(name: Option[String]): Example
    Definition Classes
    AnyShape
  141. def withExamples(examples: Seq[Example]): SchemaShape.this.type
    Definition Classes
    AnyShape
  142. def withExtends(extend: Seq[DomainElement]): SchemaShape.this.type
    Definition Classes
    DomainElement
  143. def withId(value: String): SchemaShape.this.type
    Definition Classes
    AmfObject
  144. def withInherits(inherits: Seq[Shape]): SchemaShape.this.type
    Definition Classes
    Shape
  145. def withLinkLabel(label: String): SchemaShape.this.type
    Definition Classes
    Linkable
  146. def withLinkTarget(target: DomainElement): SchemaShape.this.type
    Definition Classes
    Linkable
  147. def withMediaType(mediaType: String): SchemaShape
  148. def withName(name: String, a: Annotations): SchemaShape.this.type
    Definition Classes
    NamedDomainElement
  149. def withNot(shape: Shape): SchemaShape.this.type
    Definition Classes
    Shape
  150. def withOr(subShapes: Seq[Shape]): SchemaShape.this.type
    Definition Classes
    Shape
  151. def withRaw(text: String): SchemaShape
  152. def withReference(id: String): SchemaShape.this.type
    Definition Classes
    ExternalSourceElement
  153. def withSupportsRecursion(recursive: Boolean): SchemaShape.this.type
    Definition Classes
    Linkable
  154. def withValues(values: Seq[DataNode]): SchemaShape.this.type
    Definition Classes
    Shape
  155. def withXMLSerialization(xmlSerialization: XMLSerializer): SchemaShape.this.type
    Definition Classes
    AnyShape
  156. def withXone(subShapes: Seq[Shape]): SchemaShape.this.type
    Definition Classes
    Shape
  157. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
  158. def xone: Seq[Shape]
    Definition Classes
    Shape

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyShape

Inherited from InheritanceChain

Inherited from ExternalSourceElement

Inherited from RamlDatatypeSerializer

Inherited from JsonSchemaSerializer

Inherited from ShapeHelpers

Inherited from JsonSchemaSecrets

Inherited from Shape

Inherited from NamedDomainElement

Inherited from Linkable

Inherited from DomainElement

Inherited from AmfObject

Inherited from AmfElement

Inherited from AnyRef

Inherited from Any

Ungrouped