c

amf.client.model.domain

ArrayShape

case class ArrayShape(_internal: plugins.domain.shapes.models.ArrayShape) extends DataArrangeShape with Product with Serializable

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

Instance Constructors

  1. new ArrayShape()
    Annotations
    @JSExportTopLevel( "model.domain.ArrayShape" )
  2. new ArrayShape(_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
    Annotations
    @JSExport()
  9. def buildJsonSchema(exec: BaseExecutionEnvironment): String
    Definition Classes
    AnyShape
  10. def buildJsonSchema(): 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
    Annotations
    @JSExport()
  11. def buildRamlDatatype(exec: BaseExecutionEnvironment): String
    Definition Classes
    AnyShape
  12. def buildRamlDatatype(): 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
    Annotations
    @JSExport()
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  14. def comment: StrField
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  15. def contains: Shape
  16. def customDomainProperties: convert.CoreClientConverters.ClientList[DomainExtension]
    Definition Classes
    DomainElement → CustomizableElement
  17. def customShapeProperties: convert.CoreClientConverters.ClientList[ShapeExtension]
    Definition Classes
    Shape
  18. def customShapePropertyDefinitions: convert.CoreClientConverters.ClientList[PropertyShape]
    Definition Classes
    Shape
  19. def defaultValue: DataNode
    Definition Classes
    Shape
  20. def defaultValueStr: StrField
    Definition Classes
    Shape
  21. def deprecated: BoolField
    Definition Classes
    Shape
  22. def description: StrField
    Definition Classes
    Shape
  23. def displayName: StrField
    Definition Classes
    Shape
  24. def documentation: CreativeWork
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  25. def elseShape: Shape
    Definition Classes
    Shape
  26. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. def examples: ClientList[Example]
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  28. def extendsNode: convert.CoreClientConverters.ClientList[DomainElement]
    Definition Classes
    DomainElement
  29. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  30. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  31. def graph(): Graph
    Definition Classes
    DomainElement
  32. def id: String
    Definition Classes
    DomainElement
  33. def ifShape: Shape
    Definition Classes
    Shape
  34. def inherits: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape
  35. def inlined(): Boolean
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  36. 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
    Annotations
    @JSExport()
  37. def isExternalLink: BoolField
    Definition Classes
    DomainElement
  38. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  39. def isLink: Boolean
    Definition Classes
    Linkable
  40. def items: Shape
  41. def link[T](label: Option[String]): T
    Definition Classes
    Linkable
  42. def linkCopy(): ArrayShape
    Definition Classes
    ArrayShape → AnyShape → Linkable
  43. def linkLabel: StrField
    Definition Classes
    Linkable
  44. def linkTarget: convert.CoreClientConverters.ClientOption[DomainElement]
    Definition Classes
    Linkable
  45. def maxContains: Int
  46. def maxItems: IntField
    Definition Classes
    DataArrangeShape
  47. def minContains: Int
  48. def minItems: IntField
    Definition Classes
    DataArrangeShape
  49. def name: StrField
    Definition Classes
    Shape → NamedDomainElement
  50. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  51. def not: Shape
    Definition Classes
    Shape
  52. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  53. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  54. def or: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape
  55. def parameterValidator(mediaType: String, env: Environment): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
    Annotations
    @JSExport()
  56. def parameterValidator(mediaType: String, exec: BaseExecutionEnvironment): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
  57. def parameterValidator(mediaType: String): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
    Annotations
    @JSExport()
  58. def payloadValidator(mediaType: String, env: Environment): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
    Annotations
    @JSExport()
  59. def payloadValidator(mediaType: String, exec: BaseExecutionEnvironment): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
  60. def payloadValidator(mediaType: String): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
    Annotations
    @JSExport()
  61. val platform: Platform
    Definition Classes
    PlatformSecrets
  62. def position: Range
    Definition Classes
    DomainElement
  63. def readOnly: BoolField
    Definition Classes
    Shape
  64. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  65. def thenShape: Shape
    Definition Classes
    Shape
  66. def toJsonSchema(exec: BaseExecutionEnvironment): String
    Definition Classes
    AnyShape
  67. def toJsonSchema(): 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
    Annotations
    @JSExport()
  68. def toRamlDatatype(exec: BaseExecutionEnvironment): String
    Definition Classes
    AnyShape
  69. def toRamlDatatype(): 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
    Annotations
    @JSExport()
  70. 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
    Annotations
    @JSExport()
  71. def unevaluatedItems: Boolean
  72. def unevaluatedItemsSchema: Shape
  73. def uniqueItems: BoolField
    Definition Classes
    DataArrangeShape
  74. def validate(fragment: PayloadFragment, env: Environment, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  75. def validate(fragment: PayloadFragment, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  76. def validate(fragment: PayloadFragment, env: Environment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  77. def validate(fragment: PayloadFragment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  78. def validate(payload: String, env: Environment, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  79. def validate(payload: String, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  80. def validate(payload: String, env: Environment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  81. def validate(payload: String): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  82. def validateParameter(payload: String, env: Environment, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  83. def validateParameter(payload: String, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  84. def validateParameter(payload: String, env: Environment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  85. def validateParameter(payload: String): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  86. def values: convert.CoreClientConverters.ClientList[DataNode]
    Definition Classes
    Shape
  87. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  88. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  89. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  90. def withAnd(subShapes: convert.CoreClientConverters.ClientList[Shape]): ArrayShape.this.type
    Definition Classes
    Shape
  91. def withComment(comment: String): ArrayShape.this.type
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  92. def withContains(contains: Shape): ArrayShape.this.type
  93. def withCustomDomainProperties(extensions: convert.CoreClientConverters.ClientList[DomainExtension]): ArrayShape.this.type
    Definition Classes
    DomainElement → CustomizableElement
  94. def withCustomShapeProperties(customShapeProperties: convert.CoreClientConverters.ClientList[ShapeExtension]): ArrayShape.this.type
    Definition Classes
    Shape
  95. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  96. def withCustomShapePropertyDefinitions(propertyDefinitions: convert.CoreClientConverters.ClientList[PropertyShape]): ArrayShape.this.type
    Definition Classes
    Shape
  97. def withDefaultStr(value: String): ArrayShape.this.type
    Definition Classes
    Shape
  98. def withDefaultValue(defaultVal: DataNode): ArrayShape.this.type
    Definition Classes
    Shape
  99. def withDeprecated(deprecated: Boolean): ArrayShape.this.type
    Definition Classes
    Shape
  100. def withDescription(description: String): ArrayShape.this.type
    Definition Classes
    Shape
  101. def withDisplayName(name: String): ArrayShape.this.type
    Definition Classes
    Shape
  102. def withDocumentation(documentation: CreativeWork): ArrayShape.this.type
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  103. def withElse(elseShape: Shape): ArrayShape.this.type
    Definition Classes
    Shape
  104. def withExample(mediaType: String): Example
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  105. def withExamples(examples: ClientList[Example]): ArrayShape.this.type
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  106. def withExtendsNode(extension: convert.CoreClientConverters.ClientList[ParametrizedDeclaration]): ArrayShape.this.type
    Definition Classes
    DomainElement
  107. def withId(id: String): ArrayShape.this.type
    Definition Classes
    DomainElement
  108. def withIf(ifShape: Shape): ArrayShape.this.type
    Definition Classes
    Shape
  109. def withInherits(inherits: convert.CoreClientConverters.ClientList[Shape]): ArrayShape.this.type
    Definition Classes
    Shape
  110. def withIsExternalLink(isExternalLink: Boolean): DomainElement
    Definition Classes
    DomainElement
  111. def withItems(items: Shape): ArrayShape.this.type
  112. def withLinkLabel(label: String): ArrayShape.this.type
    Definition Classes
    Linkable
  113. def withLinkTarget(target: DomainElement with Linkable): ArrayShape.this.type
    Definition Classes
    Linkable
  114. def withMaxContains(amount: Int): ArrayShape.this.type
  115. def withMaxItems(maxItems: Int): ArrayShape.this.type
    Definition Classes
    DataArrangeShape
  116. def withMinContains(amount: Int): ArrayShape.this.type
  117. def withMinItems(minItems: Int): ArrayShape.this.type
    Definition Classes
    DataArrangeShape
  118. def withName(name: String): ArrayShape.this.type
    Definition Classes
    Shape → NamedDomainElement
  119. def withNode(shape: Shape): ArrayShape.this.type
    Definition Classes
    Shape
  120. def withOr(subShapes: convert.CoreClientConverters.ClientList[Shape]): ArrayShape.this.type
    Definition Classes
    Shape
  121. def withReadOnly(readOnly: Boolean): ArrayShape.this.type
    Definition Classes
    Shape
  122. def withThen(thenShape: Shape): ArrayShape.this.type
    Definition Classes
    Shape
  123. def withUnevaluatedItems(value: Boolean): ArrayShape.this.type
  124. def withUnevaluatedItemsSchema(schema: Shape): ArrayShape.this.type
  125. def withUniqueItems(uniqueItems: Boolean): ArrayShape.this.type
    Definition Classes
    DataArrangeShape
  126. def withValues(values: convert.CoreClientConverters.ClientList[DataNode]): ArrayShape.this.type
    Definition Classes
    Shape
  127. def withWriteOnly(writeOnly: Boolean): ArrayShape.this.type
    Definition Classes
    Shape
  128. def withXMLSerialization(xmlSerialization: XMLSerializer): ArrayShape.this.type
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  129. def withXone(subShapes: convert.CoreClientConverters.ClientList[Shape]): ArrayShape.this.type
    Definition Classes
    Shape
  130. def writeOnly: BoolField
    Definition Classes
    Shape
  131. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  132. def xone: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from DataArrangeShape

Inherited from AnyShape

Inherited from ValidatorAware

Inherited from Shape

Inherited from NamedDomainElement

Inherited from Linkable

Inherited from DomainElement

Inherited from CustomizableElement

Inherited from PlatformSecrets

Inherited from AmfObjectWrapper

Inherited from Annotable

Inherited from AnyRef

Inherited from Any

Ungrouped