c

amf.client.model.domain

DataArrangeShape

abstract class DataArrangeShape extends AnyShape

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

Instance Constructors

  1. new DataArrangeShape(_internal: DataArrangementShape)

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

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