c

amf.client.model.domain

MatrixShape

class MatrixShape extends ArrayShape

Annotations
@JSExportAll()
Linear Supertypes
ArrayShape, Serializable, Serializable, Product, Equals, DataArrangeShape, AnyShape, Shape, NamedDomainElement, Linkable, DomainElement, PlatformSecrets, AmfObjectWrapper, Annotable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MatrixShape
  2. ArrayShape
  3. Serializable
  4. Serializable
  5. Product
  6. Equals
  7. DataArrangeShape
  8. AnyShape
  9. Shape
  10. NamedDomainElement
  11. Linkable
  12. DomainElement
  13. PlatformSecrets
  14. AmfObjectWrapper
  15. Annotable
  16. AnyRef
  17. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MatrixShape()
    Annotations
    @JSExportTopLevel( "model.domain.MatrixShape" )
  2. new MatrixShape(_internal: plugins.domain.shapes.models.ArrayShape)

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 and: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape
  5. def annotations(): Annotations
    Definition Classes
    AmfObjectWrapper → Annotable
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def buildJsonSchema(options: ShapeRenderOptions, exec: BaseExecutionEnvironment): String
    Definition Classes
    AnyShape
  8. def buildJsonSchema(options: ShapeRenderOptions): String
    Definition Classes
    AnyShape
  9. def buildJsonSchema(exec: BaseExecutionEnvironment = ...): String

    Force a new json schema generation, no matter if the shape was parsed from that kind of expression or if was previously generated.

    Force a new json schema generation, no matter if the shape was parsed from that kind of expression or if was previously generated. Stores the result for futures toJsonSchema invocations. Should use this method when you have mutated this instance

    Definition Classes
    AnyShape
  10. def buildRamlDatatype(exec: BaseExecutionEnvironment = ...): String

    Forces a new RAML Data Type generation, no matter if the shape was parsed from that kind of expression or if was previously generated.

    Forces a new RAML Data Type generation, no matter if the shape was parsed from that kind of expression or if was previously generated. Stores the result for futures toRamlDatatype invocations. Call this method to generate a new RAML Data Type when this instance was mutated. Proxies call to internal AnyShape.toRamlDatatype.

    Definition Classes
    AnyShape
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  12. def comment: StrField
    Definition Classes
    AnyShape
  13. def contains: Shape
    Definition Classes
    ArrayShape
  14. def customDomainProperties: convert.CoreClientConverters.ClientList[DomainExtension]
    Definition Classes
    DomainElement
  15. def customShapeProperties: convert.CoreClientConverters.ClientList[ShapeExtension]
    Definition Classes
    Shape
  16. def customShapePropertyDefinitions: convert.CoreClientConverters.ClientList[PropertyShape]
    Definition Classes
    Shape
  17. def defaultValue: DataNode
    Definition Classes
    Shape
  18. def defaultValueStr: StrField
    Definition Classes
    Shape
  19. def deprecated: BoolField
    Definition Classes
    Shape
  20. def description: StrField
    Definition Classes
    Shape
  21. def displayName: StrField
    Definition Classes
    Shape
  22. def documentation: CreativeWork
    Definition Classes
    AnyShape
  23. def elseShape: Shape
    Definition Classes
    Shape
  24. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def examples: ClientList[Example]
    Definition Classes
    AnyShape
  26. def extendsNode: convert.CoreClientConverters.ClientList[DomainElement]
    Definition Classes
    DomainElement
  27. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  28. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. def graph(): Graph
    Definition Classes
    DomainElement
  30. def id: String
    Definition Classes
    DomainElement
  31. def ifShape: Shape
    Definition Classes
    Shape
  32. def inherits: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape
  33. def inlined(): Boolean
    Definition Classes
    AnyShape
  34. 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
  35. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  36. def isLink: Boolean
    Definition Classes
    Linkable
  37. def items: Shape
    Definition Classes
    ArrayShape
  38. def link[T](label: Option[String]): T
    Definition Classes
    Linkable
  39. def linkCopy(): ArrayShape
    Definition Classes
    ArrayShape → AnyShape → Linkable
  40. def linkLabel: StrField
    Definition Classes
    Linkable
  41. def linkTarget: convert.CoreClientConverters.ClientOption[DomainElement]
    Definition Classes
    Linkable
  42. def maxItems: IntField
    Definition Classes
    DataArrangeShape
  43. def minItems: IntField
    Definition Classes
    DataArrangeShape
  44. def name: StrField
    Definition Classes
    Shape → NamedDomainElement
  45. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  46. def not: Shape
    Definition Classes
    Shape
  47. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  48. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  49. def or: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape
  50. def parameterValidator(mediaType: String, env: Environment): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape
  51. def parameterValidator(mediaType: String, exec: BaseExecutionEnvironment = ...): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape
  52. def payloadValidator(mediaType: String, env: Environment): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape
  53. def payloadValidator(mediaType: String, exec: BaseExecutionEnvironment = ...): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape
  54. val platform: Platform
    Definition Classes
    PlatformSecrets
  55. def position: Range
    Definition Classes
    DomainElement
  56. def readOnly: BoolField
    Definition Classes
    Shape
  57. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  58. def thenShape: Shape
    Definition Classes
    Shape
  59. def toJsonSchema(exec: BaseExecutionEnvironment = ...): String

    if the shape was parsed of a json schema, or has been previously generated a new json schema, returns thar value, otherwise generate a new json schema and store the value for futures invocations

    if the shape was parsed of a json schema, or has been previously generated a new json schema, returns thar value, otherwise generate a new json schema and store the value for futures invocations

    Definition Classes
    AnyShape
  60. def toRamlDatatype(exec: BaseExecutionEnvironment = ...): String

    If the shape was parsed of RAML, or a new RAML has been previously generated, returns that value, otherwise generates a new RAML Data Type and stores the value for futures invocations.

    If the shape was parsed of RAML, or a new RAML has been previously generated, returns that value, otherwise generates a new RAML Data Type and stores the value for futures invocations. Proxies call to internal AnyShape.toRamlDatatype.

    Definition Classes
    AnyShape
  61. def trackedExample(trackId: String): ClientOption[Example]

    trackId

    parent id of the original payload type with simpleinheritance and the searched example.

    returns

    A ClientOption of the original inlined example, or empty if there is not any example with that track information annotated.

    Definition Classes
    AnyShape
  62. def uniqueItems: BoolField
    Definition Classes
    DataArrangeShape
  63. def validate(fragment: PayloadFragment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  64. def validate(fragment: PayloadFragment, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  65. def validate(fragment: PayloadFragment, env: Environment, exec: BaseExecutionEnvironment = ...): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  66. def validate(payload: String): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  67. def validate(payload: String, env: Environment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  68. def validate(payload: String, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  69. def validate(payload: String, env: Environment, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  70. def validateParameter(payload: String): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  71. def validateParameter(payload: String, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  72. def validateParameter(payload: String, env: Environment, exec: BaseExecutionEnvironment = ...): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  73. def values: convert.CoreClientConverters.ClientList[DataNode]
    Definition Classes
    Shape
  74. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  75. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  76. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  77. def withAnd(subShapes: convert.CoreClientConverters.ClientList[Shape]): MatrixShape.this.type
    Definition Classes
    Shape
  78. def withComment(comment: String): MatrixShape.this.type
    Definition Classes
    AnyShape
  79. def withContains(contains: Shape): MatrixShape.this.type
    Definition Classes
    ArrayShape
  80. def withCustomDomainProperties(extensions: convert.CoreClientConverters.ClientList[DomainExtension]): MatrixShape.this.type
    Definition Classes
    DomainElement
  81. def withCustomShapeProperties(customShapeProperties: convert.CoreClientConverters.ClientList[ShapeExtension]): MatrixShape.this.type
    Definition Classes
    Shape
  82. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  83. def withCustomShapePropertyDefinitions(propertyDefinitions: convert.CoreClientConverters.ClientList[PropertyShape]): MatrixShape.this.type
    Definition Classes
    Shape
  84. def withDefaultStr(value: String): MatrixShape.this.type
    Definition Classes
    Shape
  85. def withDefaultValue(default: DataNode): MatrixShape.this.type
    Definition Classes
    Shape
  86. def withDeprecated(deprecated: Boolean): MatrixShape.this.type
    Definition Classes
    Shape
  87. def withDescription(description: String): MatrixShape.this.type
    Definition Classes
    Shape
  88. def withDisplayName(name: String): MatrixShape.this.type
    Definition Classes
    Shape
  89. def withDocumentation(documentation: CreativeWork): MatrixShape.this.type
    Definition Classes
    AnyShape
  90. def withElse(elseShape: Shape): MatrixShape.this.type
    Definition Classes
    Shape
  91. def withExample(mediaType: String): Example
    Definition Classes
    AnyShape
  92. def withExamples(examples: ClientList[Example]): MatrixShape.this.type
    Definition Classes
    AnyShape
  93. def withExtendsNode(extension: convert.CoreClientConverters.ClientList[ParametrizedDeclaration]): MatrixShape.this.type
    Definition Classes
    DomainElement
  94. def withId(id: String): MatrixShape.this.type
    Definition Classes
    DomainElement
  95. def withIf(ifShape: Shape): MatrixShape.this.type
    Definition Classes
    Shape
  96. def withInherits(inherits: convert.CoreClientConverters.ClientList[Shape]): MatrixShape.this.type
    Definition Classes
    Shape
  97. def withItems(items: Shape): MatrixShape.this.type
    Definition Classes
    MatrixShape → ArrayShape
  98. def withLinkLabel(label: String): MatrixShape.this.type
    Definition Classes
    Linkable
  99. def withLinkTarget(target: DomainElement with Linkable): MatrixShape.this.type
    Definition Classes
    Linkable
  100. def withMaxItems(maxItems: Int): MatrixShape.this.type
    Definition Classes
    DataArrangeShape
  101. def withMinItems(minItems: Int): MatrixShape.this.type
    Definition Classes
    DataArrangeShape
  102. def withName(name: String): MatrixShape.this.type
    Definition Classes
    Shape → NamedDomainElement
  103. def withNode(shape: Shape): MatrixShape.this.type
    Definition Classes
    Shape
  104. def withOr(subShapes: convert.CoreClientConverters.ClientList[Shape]): MatrixShape.this.type
    Definition Classes
    Shape
  105. def withReadOnly(readOnly: Boolean): MatrixShape.this.type
    Definition Classes
    Shape
  106. def withThen(thenShape: Shape): MatrixShape.this.type
    Definition Classes
    Shape
  107. def withUniqueItems(uniqueItems: Boolean): MatrixShape.this.type
    Definition Classes
    DataArrangeShape
  108. def withValues(values: convert.CoreClientConverters.ClientList[DataNode]): MatrixShape.this.type
    Definition Classes
    Shape
  109. def withWriteOnly(writeOnly: Boolean): MatrixShape.this.type
    Definition Classes
    Shape
  110. def withXMLSerialization(xmlSerialization: XMLSerializer): MatrixShape.this.type
    Definition Classes
    AnyShape
  111. def withXone(subShapes: convert.CoreClientConverters.ClientList[Shape]): MatrixShape.this.type
    Definition Classes
    Shape
  112. def writeOnly: BoolField
    Definition Classes
    Shape
  113. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
  114. def xone: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape

Inherited from ArrayShape

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from DataArrangeShape

Inherited from AnyShape

Inherited from Shape

Inherited from NamedDomainElement

Inherited from Linkable

Inherited from DomainElement

Inherited from PlatformSecrets

Inherited from AmfObjectWrapper

Inherited from Annotable

Inherited from AnyRef

Inherited from Any

Ungrouped