case class MatrixShape(fields: Fields, annotations: Annotations) extends DataArrangementShape with Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, DataArrangementShape, AnyShape, ValidatorAware, ExemplifiedDomainElement, DocumentedElement, InheritanceChain, ExternalSourceElement, RamlDatatypeSerializer, JsonSchemaSerializer, PlatformSecrets, ShapeHelpers, JsonSchemaSecrets, Shape, ShapeHelper, NamedDomainElement, Linkable, DomainElement, AmfObject, AmfElement, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MatrixShape
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. DataArrangementShape
  7. AnyShape
  8. ValidatorAware
  9. ExemplifiedDomainElement
  10. DocumentedElement
  11. InheritanceChain
  12. ExternalSourceElement
  13. RamlDatatypeSerializer
  14. JsonSchemaSerializer
  15. PlatformSecrets
  16. ShapeHelpers
  17. JsonSchemaSecrets
  18. Shape
  19. ShapeHelper
  20. NamedDomainElement
  21. Linkable
  22. DomainElement
  23. AmfObject
  24. AmfElement
  25. AnyRef
  26. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MatrixShape(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): MatrixShape.this.type
    Definition Classes
    AmfObject
  5. def add(other: Annotations): MatrixShape.this.type
    Definition Classes
    AmfElement
  6. def add(annotation: Annotation): MatrixShape.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] = Seq()): MatrixShape.this.type
    Definition Classes
    DataArrangementShape → 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
    MatrixShape → AnyShape → 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(options: ShapeRenderOptions = ShapeRenderOptions(), exec: BaseExecutionEnvironment = ...): String
    Definition Classes
    AnyShape
  16. def buildRamlDatatype(exec: BaseExecutionEnvironment = ...): 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
    MatrixShape → AnyShape → Linkable
  18. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  19. def cloneAllExamples(cloned: Shape, s: Shape): Unit
    Definition Classes
    ShapeHelpers
  20. def cloneShape(recursionErrorHandler: Option[ErrorHandler], withRecursionBase: Option[String] = None, traversal: ModelTraversalRegistry = ModelTraversalRegistry(), cloneExamples: Boolean = false): MatrixShape.this.type
    Definition Classes
    ShapeHelpers
  21. def collectCustomShapePropertyDefinitions(onlyInherited: Boolean, traversed: Set[String]): Seq[FacetsMap]
    Definition Classes
    Shape
  22. def collectionFormat: String
    Definition Classes
    DataArrangementShape
  23. def comment: StrField
    Definition Classes
    AnyShape
  24. 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
    DataArrangementShape → AnyShape → AmfObject
  25. def computeSubtypesClosure(): Seq[Shape]
    Attributes
    protected
    Definition Classes
    InheritanceChain
  26. def copyAnyShape(fields: Fields = fields, annotations: Annotations = annotations): AnyShape
    Definition Classes
    AnyShape
  27. def copyElement(a: Annotations): Linkable with DomainElement
    Definition Classes
    Linkable
  28. def copyElement(): Linkable with DomainElement
    Definition Classes
    Linkable
  29. def copyFields(recursionErrorHandler: Option[ErrorHandler], cloned: Shape, recursionBase: Option[String], traversal: ModelTraversalRegistry): Unit
    Attributes
    protected
    Definition Classes
    Shape
  30. def copyShape(): MatrixShape.this.type
    Definition Classes
    AnyShape → Shape
  31. def copyShape(a: Annotations): MatrixShape.this.type
    Definition Classes
    Shape
  32. def customDomainProperties: Seq[DomainExtension]
    Definition Classes
    DomainElement
  33. def customShapeProperties: Seq[ShapeExtension]
    Definition Classes
    Shape
  34. def customShapePropertyDefinitions: Seq[PropertyShape]
    Definition Classes
    Shape
  35. def default: DataNode
    Definition Classes
    Shape
  36. def defaultString: StrField
    Definition Classes
    Shape
  37. def deprecated: BoolField
    Definition Classes
    Shape
  38. def description: StrField
    Definition Classes
    Shape
  39. def displayName: StrField
    Definition Classes
    Shape
  40. def documentation: CreativeWork
    Definition Classes
    AnyShape
  41. def documentations: Seq[CreativeWork]
    Definition Classes
    AnyShape → DocumentedElement
  42. def effectiveInherits: Seq[Shape]
    Definition Classes
    Shape
  43. def effectiveLinkTarget(links: Seq[String]): DomainElement
    Definition Classes
    Linkable
  44. def effectiveStructuralShapes: Seq[Shape]
    Definition Classes
    InheritanceChain
  45. def elseShape: Shape
    Definition Classes
    Shape
  46. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  47. def examples: Seq[Example]
    Definition Classes
    ExemplifiedDomainElement
  48. def extend: Seq[DomainElement]
    Definition Classes
    DomainElement
  49. def externalSourceID: Option[String]
    Definition Classes
    ShapeHelpers
  50. val fields: Fields
    Definition Classes
    MatrixShape → AnyShape → AmfObject
  51. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  52. def fromExternalSource: Boolean
    Definition Classes
    ShapeHelpers
  53. def fromLocal(): Boolean
    Definition Classes
    AmfElement
  54. def generateJsonSchema(element: AnyShape, options: ShapeRenderOptions = ShapeRenderOptions(), exec: BaseExecutionEnvironment): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  55. def generateRamlDatatype(element: AnyShape, exec: BaseExecutionEnvironment): 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
  56. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  57. lazy val graph: Graph
    Definition Classes
    DomainElement
  58. val id: String
    Definition Classes
    AmfObject
  59. def ifShape: Shape
    Definition Classes
    Shape
  60. val inheritedIds: Seq[String]
    Definition Classes
    InheritanceChain
  61. def inherits: Seq[Shape]
    Definition Classes
    Shape
  62. def inlined: Boolean
    Definition Classes
    AnyShape
  63. def isAnyType: Boolean
    Definition Classes
    AnyShape
  64. 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
  65. def isExternalLink: BoolField
    Definition Classes
    DomainElement
  66. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  67. def isLink: Boolean
    Definition Classes
    Linkable
  68. def isLinkToSource: Boolean
    Definition Classes
    ExternalSourceElement
  69. def isTrackedBy(trackId: String): Boolean
    Definition Classes
    AmfElement
  70. val isUnresolved: Boolean
    Definition Classes
    Linkable
  71. def items: Shape
  72. def link[T](label: String, annotations: Annotations): T
    Definition Classes
    Linkable
  73. val linkAnnotations: Option[Annotations]
    Definition Classes
    Linkable
  74. def linkCopy(): MatrixShape
    Definition Classes
    MatrixShape → AnyShape → Linkable
  75. def linkLabel: StrField
    Definition Classes
    Linkable
  76. def linkSubType(shape: AnyShape): Unit
    Definition Classes
    InheritanceChain
  77. def linkTarget: Option[DomainElement]
    Definition Classes
    Linkable
  78. def location(): Option[String]
    Definition Classes
    ExternalSourceElement → AmfElement
  79. def maxItems: IntField
    Definition Classes
    DataArrangementShape
  80. val meta: AnyShapeModel
    Definition Classes
    MatrixShape → AnyShape → AmfObject
  81. def minItems: IntField
    Definition Classes
    DataArrangementShape
  82. def name: StrField
    Definition Classes
    NamedDomainElement
  83. def nameField: Field
    Attributes
    protected
    Definition Classes
    Shape → NamedDomainElement
  84. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  85. def not: Shape
    Definition Classes
    Shape
  86. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  87. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  88. def or: Seq[Shape]
    Definition Classes
    Shape
  89. def parameterValidator(mediaType: String, exec: BaseExecutionEnvironment): Option[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
  90. def parameterValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
  91. def payloadValidator(mediaType: String, exec: BaseExecutionEnvironment): Option[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
  92. def payloadValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
  93. def payloadValidator(shape: Shape, env: Environment, validationMode: ValidationMode): PlatformPayloadValidator
    Attributes
    protected
    Definition Classes
    JsonSchemaSecrets
  94. val platform: Platform
    Definition Classes
    PlatformSecrets
  95. def position(): Option[LexicalInformation]
    Definition Classes
    AmfElement
  96. def ramlSyntaxKey: String
    Definition Classes
    DataArrangementShape → AnyShape → Shape
  97. def raw: StrField
    Definition Classes
    ExternalSourceElement
  98. def readOnly: BoolField
    Definition Classes
    Shape
  99. val refAst: Option[YPart]
    Definition Classes
    Linkable
  100. val refCtx: Option[ParserContext]
    Definition Classes
    Linkable
  101. val refName: String
    Definition Classes
    Linkable
  102. def referenceId: StrField
    Definition Classes
    ExternalSourceElement
  103. def removeExamples(): Unit
    Definition Classes
    ExemplifiedDomainElement
  104. def resolveUnreferencedLink[T](label: String, annotations: Annotations, unresolved: T, supportsRecursion: Boolean): T
    Definition Classes
    Linkable
  105. def set(field: Field, value: AmfElement, annotations: Annotations): MatrixShape.this.type
    Definition Classes
    AmfObject
  106. def set(field: Field, value: AmfElement): MatrixShape.this.type
    Definition Classes
    AmfObject
  107. def set(field: Field, values: Seq[String]): MatrixShape.this.type
    Definition Classes
    AmfObject
  108. def set(field: Field, value: Float): MatrixShape.this.type
    Definition Classes
    AmfObject
  109. def set(field: Field, value: Double): MatrixShape.this.type
    Definition Classes
    AmfObject
  110. def set(field: Field, value: Int): MatrixShape.this.type
    Definition Classes
    AmfObject
  111. def set(field: Field, value: Boolean): MatrixShape.this.type
    Definition Classes
    AmfObject
  112. def set(field: Field, value: String): MatrixShape.this.type
    Definition Classes
    AmfObject
  113. def setArray(field: Field, values: Seq[AmfElement], annotations: Annotations): MatrixShape.this.type
    Definition Classes
    AmfObject
  114. def setArray(field: Field, values: Seq[AmfElement]): MatrixShape.this.type
    Definition Classes
    AmfObject
  115. def setArrayWithoutId(field: Field, values: Seq[AmfElement], annotations: Annotations): MatrixShape.this.type
    Definition Classes
    AmfObject
  116. def setArrayWithoutId(field: Field, values: Seq[AmfElement]): MatrixShape.this.type
    Definition Classes
    AmfObject
  117. def setDefaultStrValue(entry: YMapEntry): Unit
    Definition Classes
    ShapeHelper
  118. def setWithoutId(field: Field, value: AmfElement, annotations: Annotations): MatrixShape.this.type
    Definition Classes
    AmfObject
  119. val shouldLink: Boolean
    Attributes
    protected
    Definition Classes
    Linkable
  120. final def simpleAdoption(parent: String): MatrixShape.this.type
    Definition Classes
    AmfObject
  121. val subTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  122. val superTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  123. def supportsRecursion: BoolField
    Definition Classes
    Linkable
  124. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  125. def thenShape: Shape
    Definition Classes
    Shape
  126. def toArrayShape: ArrayShape
  127. def toFutureRef(resolve: (Linkable) ⇒ Unit): Unit
    Definition Classes
    Linkable
  128. def toJsonSchema(exec: BaseExecutionEnvironment = ...): String
    Definition Classes
    AnyShape
  129. def toJsonSchema(element: AnyShape, exec: BaseExecutionEnvironment): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  130. def toMatrixShape: MatrixShape
  131. def toRamlDatatype(exec: BaseExecutionEnvironment = ...): 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
  132. def toRamlDatatype(element: AnyShape, exec: BaseExecutionEnvironment): 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
  133. def trackedExample(trackId: String): Option[Example]
    Definition Classes
    AnyShape
  134. def typeExpression: Option[String]
    Definition Classes
    ShapeHelpers
  135. def uniqueItems: BoolField
    Definition Classes
    DataArrangementShape
  136. def unresolved(refName: String, refAst: YPart, unresolvedSeverity: String)(implicit ctx: ParserContext): DomainElement with Linkable
    Definition Classes
    Linkable
  137. val unresolvedSeverity: String
    Definition Classes
    Linkable
  138. def validate(fragment: PayloadFragment, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  139. def validate(fragment: PayloadFragment, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  140. def validate(fragment: PayloadFragment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  141. def validate(fragment: PayloadFragment, env: Environment, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  142. def validate(payload: String, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  143. def validate(payload: String, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  144. def validate(payload: String): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  145. def validate(payload: String, env: Environment, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  146. def validateParameter(payload: String, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  147. def validateParameter(payload: String, env: Environment = Environment(), exec: BaseExecutionEnvironment = ...): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  148. def values: Seq[DataNode]
    Definition Classes
    Shape
  149. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  150. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  151. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  152. def withAnd(subShapes: Seq[Shape]): MatrixShape.this.type
    Definition Classes
    Shape
  153. def withArrayItems(): ArrayShape
    Definition Classes
    DataArrangementShape
  154. def withCollectionFormat(collectionFormat: Boolean): MatrixShape.this.type
    Definition Classes
    DataArrangementShape
  155. def withComment(comment: String): MatrixShape.this.type
    Definition Classes
    AnyShape
  156. def withCustomDomainProperties(extensions: Seq[DomainExtension]): MatrixShape.this.type
    Definition Classes
    DomainElement
  157. def withCustomDomainProperty(extensions: DomainExtension): MatrixShape.this.type
    Definition Classes
    DomainElement
  158. def withCustomShapeProperties(properties: Seq[ShapeExtension]): MatrixShape.this.type
    Definition Classes
    Shape
  159. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  160. def withCustomShapePropertyDefinitions(propertyDefinitions: Seq[PropertyShape]): MatrixShape.this.type
    Definition Classes
    Shape
  161. def withDefault(default: DataNode): MatrixShape.this.type
    Definition Classes
    Shape
  162. def withDefaultStr(value: String): MatrixShape.this.type
    Definition Classes
    Shape
  163. def withDeprecated(deprecated: Boolean): MatrixShape.this.type
    Definition Classes
    Shape
  164. def withDescription(description: String): MatrixShape.this.type
    Definition Classes
    Shape
  165. def withDisplayName(name: String): MatrixShape.this.type
    Definition Classes
    Shape
  166. def withDocumentation(documentation: CreativeWork): MatrixShape.this.type
    Definition Classes
    AnyShape
  167. def withElse(elseShape: Shape): MatrixShape.this.type
    Definition Classes
    Shape
  168. def withExample(name: Option[String]): Example
    Definition Classes
    ExemplifiedDomainElement
  169. def withExamples(examples: Seq[Example]): MatrixShape.this.type
    Definition Classes
    ExemplifiedDomainElement
  170. def withExtends(extend: Seq[DomainElement]): MatrixShape.this.type
    Definition Classes
    DomainElement
  171. def withId(value: String): MatrixShape.this.type
    Definition Classes
    AmfObject
  172. def withIf(ifShape: Shape): MatrixShape.this.type
    Definition Classes
    Shape
  173. def withInherits(inherits: Seq[Shape]): MatrixShape.this.type
    Definition Classes
    Shape
  174. def withIsExternalLink(isReference: Boolean): MatrixShape.this.type
    Definition Classes
    DomainElement
  175. def withItems(items: Shape): MatrixShape.this.type
  176. def withLinkLabel(label: String): MatrixShape.this.type
    Definition Classes
    Linkable
  177. def withLinkTarget(target: DomainElement): MatrixShape.this.type
    Definition Classes
    Linkable
  178. def withMaxItems(maxItems: Int): MatrixShape.this.type
    Definition Classes
    DataArrangementShape
  179. def withMinItems(minItems: Int): MatrixShape.this.type
    Definition Classes
    DataArrangementShape
  180. def withName(name: String, a: Annotations): MatrixShape.this.type
    Definition Classes
    NamedDomainElement
  181. def withNodeItems(): NodeShape
    Definition Classes
    DataArrangementShape
  182. def withNot(shape: Shape): MatrixShape.this.type
    Definition Classes
    Shape
  183. def withOr(subShapes: Seq[Shape]): MatrixShape.this.type
    Definition Classes
    Shape
  184. def withReadOnly(readOnly: Boolean): MatrixShape.this.type
    Definition Classes
    Shape
  185. def withReference(id: String): MatrixShape.this.type
    Definition Classes
    ExternalSourceElement
  186. def withScalarItems(): ScalarShape
    Definition Classes
    DataArrangementShape
  187. def withSupportsRecursion(recursive: Boolean): MatrixShape.this.type
    Definition Classes
    Linkable
  188. def withThen(thenShape: Shape): MatrixShape.this.type
    Definition Classes
    Shape
  189. def withUniqueItems(uniqueItems: Boolean): MatrixShape.this.type
    Definition Classes
    DataArrangementShape
  190. def withValues(values: Seq[DataNode]): MatrixShape.this.type
    Definition Classes
    Shape
  191. def withWriteOnly(writeOnly: Boolean): MatrixShape.this.type
    Definition Classes
    Shape
  192. def withXMLSerialization(xmlSerialization: XMLSerializer): MatrixShape.this.type
    Definition Classes
    AnyShape
  193. def withXone(subShapes: Seq[Shape]): MatrixShape.this.type
    Definition Classes
    Shape
  194. def writeOnly: BoolField
    Definition Classes
    Shape
  195. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
  196. def xone: Seq[Shape]
    Definition Classes
    Shape

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from DataArrangementShape

Inherited from AnyShape

Inherited from ValidatorAware

Inherited from ExemplifiedDomainElement

Inherited from DocumentedElement

Inherited from InheritanceChain

Inherited from ExternalSourceElement

Inherited from RamlDatatypeSerializer

Inherited from JsonSchemaSerializer

Inherited from PlatformSecrets

Inherited from ShapeHelpers

Inherited from JsonSchemaSecrets

Inherited from Shape

Inherited from ShapeHelper

Inherited from NamedDomainElement

Inherited from Linkable

Inherited from DomainElement

Inherited from AmfObject

Inherited from AmfElement

Inherited from AnyRef

Inherited from Any

Ungrouped