c

amf.client.model.domain

TupleShape

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

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

Instance Constructors

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

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 additionalItems: BoolField
  5. def and: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape
  6. def annotations(): Annotations
    Definition Classes
    AmfObjectWrapper → Annotable
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def buildJsonSchema(options: ShapeRenderOptions): String
    Definition Classes
    AnyShape
  9. 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
  10. 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
  11. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  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 description: StrField
    Definition Classes
    Shape
  18. def displayName: StrField
    Definition Classes
    Shape
  19. def documentation: CreativeWork
    Definition Classes
    AnyShape
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def examples: ClientList[Example]
    Definition Classes
    AnyShape
  22. def extendsNode: convert.CoreClientConverters.ClientList[DomainElement]
    Definition Classes
    DomainElement
  23. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. def graph(): Graph
    Definition Classes
    DomainElement
  26. def id: String
    Definition Classes
    DomainElement
  27. def inherits: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape
  28. def inlined(): Boolean
    Definition Classes
    AnyShape
  29. 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
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. def isLink: Boolean
    Definition Classes
    Linkable
  32. def items: ClientList[Shape]
  33. def link[T](label: Option[String]): T
    Definition Classes
    Linkable
  34. def linkCopy(): TupleShape
    Definition Classes
    TupleShape → AnyShape → Linkable
  35. def linkLabel: StrField
    Definition Classes
    Linkable
  36. def linkTarget: convert.CoreClientConverters.ClientOption[DomainElement]
    Definition Classes
    Linkable
  37. def maxItems: IntField
    Definition Classes
    DataArrangeShape
  38. def minItems: IntField
    Definition Classes
    DataArrangeShape
  39. def name: StrField
    Definition Classes
    Shape → NamedDomainElement
  40. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  41. def not: Shape
    Definition Classes
    Shape
  42. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  43. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  44. def or: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape
  45. def parameterValidator(mediaType: String, env: Environment): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape
  46. def parameterValidator(mediaType: String): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape
  47. def payloadValidator(mediaType: String, env: Environment): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape
  48. def payloadValidator(mediaType: String): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape
  49. val platform: Platform
    Definition Classes
    PlatformSecrets
  50. def position: Range
    Definition Classes
    DomainElement
  51. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  52. 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
  53. 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
  54. 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
  55. def uniqueItems: BoolField
    Definition Classes
    DataArrangeShape
  56. def validate(fragment: PayloadFragment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  57. def validate(fragment: PayloadFragment, env: Environment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  58. def validate(payload: String): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  59. def validate(payload: String, env: Environment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  60. def validateParameter(payload: String): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  61. def validateParameter(payload: String, env: Environment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  62. def values: convert.CoreClientConverters.ClientList[DataNode]
    Definition Classes
    Shape
  63. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  64. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  65. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  66. def withAdditionalItems(additionalItems: Boolean): TupleShape.this.type
  67. def withAnd(subShapes: convert.CoreClientConverters.ClientList[Shape]): TupleShape.this.type
    Definition Classes
    Shape
  68. def withCustomDomainProperties(extensions: convert.CoreClientConverters.ClientList[DomainExtension]): TupleShape.this.type
    Definition Classes
    DomainElement
  69. def withCustomShapeProperties(customShapeProperties: convert.CoreClientConverters.ClientList[ShapeExtension]): TupleShape.this.type
    Definition Classes
    Shape
  70. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  71. def withCustomShapePropertyDefinitions(propertyDefinitions: convert.CoreClientConverters.ClientList[PropertyShape]): TupleShape.this.type
    Definition Classes
    Shape
  72. def withDefaultStr(value: String): TupleShape.this.type
    Definition Classes
    Shape
  73. def withDefaultValue(default: DataNode): TupleShape.this.type
    Definition Classes
    Shape
  74. def withDescription(description: String): TupleShape.this.type
    Definition Classes
    Shape
  75. def withDisplayName(name: String): TupleShape.this.type
    Definition Classes
    Shape
  76. def withDocumentation(documentation: CreativeWork): TupleShape.this.type
    Definition Classes
    AnyShape
  77. def withExample(mediaType: String): Example
    Definition Classes
    AnyShape
  78. def withExamples(examples: ClientList[Example]): TupleShape.this.type
    Definition Classes
    AnyShape
  79. def withExtendsNode(extension: convert.CoreClientConverters.ClientList[ParametrizedDeclaration]): TupleShape.this.type
    Definition Classes
    DomainElement
  80. def withId(id: String): TupleShape.this.type
    Definition Classes
    DomainElement
  81. def withInherits(inherits: convert.CoreClientConverters.ClientList[Shape]): TupleShape.this.type
    Definition Classes
    Shape
  82. def withItems(items: ClientList[Shape]): TupleShape.this.type
  83. def withLinkLabel(label: String): TupleShape.this.type
    Definition Classes
    Linkable
  84. def withLinkTarget(target: DomainElement with Linkable): TupleShape.this.type
    Definition Classes
    Linkable
  85. def withMaxItems(maxItems: Int): TupleShape.this.type
    Definition Classes
    DataArrangeShape
  86. def withMinItems(minItems: Int): TupleShape.this.type
    Definition Classes
    DataArrangeShape
  87. def withName(name: String): TupleShape.this.type
    Definition Classes
    Shape → NamedDomainElement
  88. def withNode(shape: Shape): TupleShape.this.type
    Definition Classes
    Shape
  89. def withOr(subShapes: convert.CoreClientConverters.ClientList[Shape]): TupleShape.this.type
    Definition Classes
    Shape
  90. def withUniqueItems(uniqueItems: Boolean): TupleShape.this.type
    Definition Classes
    DataArrangeShape
  91. def withValues(values: convert.CoreClientConverters.ClientList[DataNode]): TupleShape.this.type
    Definition Classes
    Shape
  92. def withXMLSerialization(xmlSerialization: XMLSerializer): TupleShape.this.type
    Definition Classes
    AnyShape
  93. def withXone(subShapes: convert.CoreClientConverters.ClientList[Shape]): TupleShape.this.type
    Definition Classes
    Shape
  94. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
  95. 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 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