c

amf.client.model.domain

DataArrangeShape

abstract class DataArrangeShape extends AnyShape

Annotations
@JSExportAll()
Linear Supertypes
AnyShape, Shape, NamedDomainElement, Linkable, DomainElement, PlatformSecrets, AmfObjectWrapper, Annotable, AnyRef, Any
Known Subclasses
ArrayShape, MatrixShape, TupleShape
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DataArrangeShape
  2. AnyShape
  3. Shape
  4. NamedDomainElement
  5. Linkable
  6. DomainElement
  7. PlatformSecrets
  8. AmfObjectWrapper
  9. Annotable
  10. AnyRef
  11. 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): String
    Definition Classes
    AnyShape
  8. 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
  9. 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
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. def comment: StrField
    Definition Classes
    AnyShape
  12. def customDomainProperties: convert.CoreClientConverters.ClientList[DomainExtension]
    Definition Classes
    DomainElement
  13. def customShapeProperties: convert.CoreClientConverters.ClientList[ShapeExtension]
    Definition Classes
    Shape
  14. def customShapePropertyDefinitions: convert.CoreClientConverters.ClientList[PropertyShape]
    Definition Classes
    Shape
  15. def defaultValue: DataNode
    Definition Classes
    Shape
  16. def defaultValueStr: StrField
    Definition Classes
    Shape
  17. def deprecated: BoolField
    Definition Classes
    Shape
  18. def description: StrField
    Definition Classes
    Shape
  19. def displayName: StrField
    Definition Classes
    Shape
  20. def documentation: CreativeWork
    Definition Classes
    AnyShape
  21. def elseShape: Shape
    Definition Classes
    Shape
  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  24. def examples: ClientList[Example]
    Definition Classes
    AnyShape
  25. def extendsNode: convert.CoreClientConverters.ClientList[DomainElement]
    Definition Classes
    DomainElement
  26. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  27. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. def graph(): Graph
    Definition Classes
    DomainElement
  29. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  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 link[T](label: Option[String]): T
    Definition Classes
    Linkable
  38. def linkCopy(): AnyShape
    Definition Classes
    AnyShape → Linkable
  39. def linkLabel: StrField
    Definition Classes
    Linkable
  40. def linkTarget: convert.CoreClientConverters.ClientOption[DomainElement]
    Definition Classes
    Linkable
  41. def maxItems: IntField
  42. def minItems: IntField
  43. def name: StrField
    Definition Classes
    Shape → NamedDomainElement
  44. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  45. def not: Shape
    Definition Classes
    Shape
  46. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  47. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  48. def or: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape
  49. def parameterValidator(mediaType: String, env: Environment): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape
  50. def parameterValidator(mediaType: String): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape
  51. def payloadValidator(mediaType: String, env: Environment): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape
  52. def payloadValidator(mediaType: String): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape
  53. val platform: Platform
    Definition Classes
    PlatformSecrets
  54. def position: Range
    Definition Classes
    DomainElement
  55. def readOnly: BoolField
    Definition Classes
    Shape
  56. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  57. def thenShape: Shape
    Definition Classes
    Shape
  58. 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
  59. 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
  60. def toString(): String
    Definition Classes
    AnyRef → Any
  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
  63. def validate(fragment: PayloadFragment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  64. def validate(fragment: PayloadFragment, env: Environment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  65. def validate(payload: String): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  66. def validate(payload: String, env: Environment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  67. def validateParameter(payload: String): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  68. def validateParameter(payload: String, env: Environment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  69. def values: convert.CoreClientConverters.ClientList[DataNode]
    Definition Classes
    Shape
  70. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  71. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  72. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  73. def withAnd(subShapes: convert.CoreClientConverters.ClientList[Shape]): DataArrangeShape.this.type
    Definition Classes
    Shape
  74. def withComment(comment: String): DataArrangeShape.this.type
    Definition Classes
    AnyShape
  75. def withCustomDomainProperties(extensions: convert.CoreClientConverters.ClientList[DomainExtension]): DataArrangeShape.this.type
    Definition Classes
    DomainElement
  76. def withCustomShapeProperties(customShapeProperties: convert.CoreClientConverters.ClientList[ShapeExtension]): DataArrangeShape.this.type
    Definition Classes
    Shape
  77. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  78. def withCustomShapePropertyDefinitions(propertyDefinitions: convert.CoreClientConverters.ClientList[PropertyShape]): DataArrangeShape.this.type
    Definition Classes
    Shape
  79. def withDefaultStr(value: String): DataArrangeShape.this.type
    Definition Classes
    Shape
  80. def withDefaultValue(default: DataNode): DataArrangeShape.this.type
    Definition Classes
    Shape
  81. def withDeprecated(deprecated: Boolean): DataArrangeShape.this.type
    Definition Classes
    Shape
  82. def withDescription(description: String): DataArrangeShape.this.type
    Definition Classes
    Shape
  83. def withDisplayName(name: String): DataArrangeShape.this.type
    Definition Classes
    Shape
  84. def withDocumentation(documentation: CreativeWork): DataArrangeShape.this.type
    Definition Classes
    AnyShape
  85. def withElse(elseShape: Shape): DataArrangeShape.this.type
    Definition Classes
    Shape
  86. def withExample(mediaType: String): Example
    Definition Classes
    AnyShape
  87. def withExamples(examples: ClientList[Example]): DataArrangeShape.this.type
    Definition Classes
    AnyShape
  88. def withExtendsNode(extension: convert.CoreClientConverters.ClientList[ParametrizedDeclaration]): DataArrangeShape.this.type
    Definition Classes
    DomainElement
  89. def withId(id: String): DataArrangeShape.this.type
    Definition Classes
    DomainElement
  90. def withIf(ifShape: Shape): DataArrangeShape.this.type
    Definition Classes
    Shape
  91. def withInherits(inherits: convert.CoreClientConverters.ClientList[Shape]): DataArrangeShape.this.type
    Definition Classes
    Shape
  92. def withLinkLabel(label: String): DataArrangeShape.this.type
    Definition Classes
    Linkable
  93. def withLinkTarget(target: DomainElement with Linkable): DataArrangeShape.this.type
    Definition Classes
    Linkable
  94. def withMaxItems(maxItems: Int): DataArrangeShape.this.type
  95. def withMinItems(minItems: Int): DataArrangeShape.this.type
  96. def withName(name: String): DataArrangeShape.this.type
    Definition Classes
    Shape → NamedDomainElement
  97. def withNode(shape: Shape): DataArrangeShape.this.type
    Definition Classes
    Shape
  98. def withOr(subShapes: convert.CoreClientConverters.ClientList[Shape]): DataArrangeShape.this.type
    Definition Classes
    Shape
  99. def withReadOnly(readOnly: Boolean): DataArrangeShape.this.type
    Definition Classes
    Shape
  100. def withThen(thenShape: Shape): DataArrangeShape.this.type
    Definition Classes
    Shape
  101. def withUniqueItems(uniqueItems: Boolean): DataArrangeShape.this.type
  102. def withValues(values: convert.CoreClientConverters.ClientList[DataNode]): DataArrangeShape.this.type
    Definition Classes
    Shape
  103. def withWriteOnly(writeOnly: Boolean): DataArrangeShape.this.type
    Definition Classes
    Shape
  104. def withXMLSerialization(xmlSerialization: XMLSerializer): DataArrangeShape.this.type
    Definition Classes
    AnyShape
  105. def withXone(subShapes: convert.CoreClientConverters.ClientList[Shape]): DataArrangeShape.this.type
    Definition Classes
    Shape
  106. def writeOnly: BoolField
    Definition Classes
    Shape
  107. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
  108. def xone: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape

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