case class TupleShape(fields: Fields, annotations: Annotations) extends DataArrangementShape with Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, DataArrangementShape, AnyShape, ExemplifiedDomainElement, InheritanceChain, ExternalSourceElement, RamlDatatypeSerializer, JsonSchemaSerializer, ShapeHelpers, JsonSchemaSecrets, Shape, ShapeHelper, NamedDomainElement, Linkable, DomainElement, AmfObject, AmfElement, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TupleShape
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. DataArrangementShape
  7. AnyShape
  8. ExemplifiedDomainElement
  9. InheritanceChain
  10. ExternalSourceElement
  11. RamlDatatypeSerializer
  12. JsonSchemaSerializer
  13. ShapeHelpers
  14. JsonSchemaSecrets
  15. Shape
  16. ShapeHelper
  17. NamedDomainElement
  18. Linkable
  19. DomainElement
  20. AmfObject
  21. AmfElement
  22. AnyRef
  23. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TupleShape(fields: Fields, annotations: Annotations)

Type Members

  1. type FacetsMap = Map[String, PropertyShape]
    Definition Classes
    Shape

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 add(field: Field, value: AmfElement): TupleShape.this.type
    Definition Classes
    AmfObject
  5. def add(other: Annotations): TupleShape.this.type
    Definition Classes
    AmfElement
  6. def add(annotation: Annotation): TupleShape.this.type
    Definition Classes
    AmfElement
  7. def addSubType(shape: Shape): Unit
    Definition Classes
    InheritanceChain
  8. def addSuperType(shape: Shape): Unit
    Definition Classes
    InheritanceChain
  9. def additionalItemsSchema: Shape
  10. def adopted(parent: String, cycle: Seq[String] = Seq()): TupleShape.this.type
    Definition Classes
    DataArrangementShape → AmfObject
  11. def afterResolve(fatherSyntaxKey: Option[String], resolvedId: String): Unit
    Definition Classes
    Linkable
  12. def and: Seq[Shape]
    Definition Classes
    Shape
  13. val annotations: Annotations
    Definition Classes
    TupleShape → AnyShape → AmfElement
  14. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  15. def buildFixPoint(id: Option[String], name: String, link: Linkable, recursionErrorHandler: Option[ErrorHandler]): RecursiveShape
    Attributes
    protected
    Definition Classes
    ShapeHelpers
  16. def buildJsonSchema(options: ShapeRenderOptions): String
    Definition Classes
    AnyShape
  17. def buildJsonSchema(): String
    Definition Classes
    AnyShape
  18. def buildRamlDatatype(): String

    Generates a new RAML Data Type.

    Generates a new RAML Data Type.

    Definition Classes
    AnyShape
  19. def classConstructor: (Fields, Annotations) ⇒ Linkable with DomainElement

    apply method for create a new instance with fields and annotations.

    apply method for create a new instance with fields and annotations. Aux method for copy

    Attributes
    protected
    Definition Classes
    TupleShape → AnyShape → Linkable
  20. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  21. def cloneAllExamples(cloned: Shape, s: Shape): Unit
    Definition Classes
    ShapeHelpers
  22. def cloneShape(recursionErrorHandler: Option[ErrorHandler], withRecursionBase: Option[String] = None, traversal: ModelTraversalRegistry = ModelTraversalRegistry(), cloneExamples: Boolean = false): TupleShape.this.type
    Definition Classes
    ShapeHelpers
  23. def closedItems: BoolField
  24. val closureShapes: Set[Shape]
    Definition Classes
    Shape
  25. def collectCustomShapePropertyDefinitions(onlyInherited: Boolean, traversed: Set[String]): Seq[FacetsMap]
    Definition Classes
    Shape
  26. def collectionFormat: String
    Definition Classes
    DataArrangementShape
  27. def comment: StrField
    Definition Classes
    AnyShape
  28. def componentId: String

    Value , path + field value that is used to compose the id when the object its adopted

    Value , path + field value that is used to compose the id when the object its adopted

    Definition Classes
    DataArrangementShape → AnyShape → AmfObject
  29. def computeSubtypesClosure(): Seq[Shape]
    Attributes
    protected
    Definition Classes
    InheritanceChain
  30. def copyAnyShape(fields: Fields = fields, annotations: Annotations = annotations): AnyShape
    Definition Classes
    AnyShape
  31. def copyElement(a: Annotations): Linkable with DomainElement
    Definition Classes
    Linkable
  32. def copyElement(): Linkable with DomainElement
    Definition Classes
    Linkable
  33. def copyFields(recursionErrorHandler: Option[ErrorHandler], cloned: Shape, recursionBase: Option[String], traversal: ModelTraversalRegistry): Unit
    Attributes
    protected
    Definition Classes
    Shape
  34. def copyShape(): TupleShape.this.type
    Definition Classes
    AnyShape → Shape
  35. def copyShape(a: Annotations): TupleShape.this.type
    Definition Classes
    Shape
  36. def customDomainProperties: Seq[DomainExtension]
    Definition Classes
    DomainElement
  37. def customShapeProperties: Seq[ShapeExtension]
    Definition Classes
    Shape
  38. def customShapePropertyDefinitions: Seq[PropertyShape]
    Definition Classes
    Shape
  39. def default: DataNode
    Definition Classes
    Shape
  40. def defaultString: StrField
    Definition Classes
    Shape
  41. def deprecated: BoolField
    Definition Classes
    Shape
  42. def description: StrField
    Definition Classes
    Shape
  43. def displayName: StrField
    Definition Classes
    Shape
  44. def documentation: CreativeWork
    Definition Classes
    AnyShape
  45. def effectiveInherits: Seq[Shape]
    Definition Classes
    Shape
  46. def effectiveLinkTarget(links: Seq[String]): DomainElement
    Definition Classes
    Linkable
  47. def effectiveStructuralShapes: Seq[Shape]
    Definition Classes
    InheritanceChain
  48. def elseShape: Shape
    Definition Classes
    Shape
  49. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  50. def examples: Seq[Example]
    Definition Classes
    ExemplifiedDomainElement
  51. def extend: Seq[DomainElement]
    Definition Classes
    DomainElement
  52. def externalSourceID: Option[String]
    Definition Classes
    ShapeHelpers
  53. val fields: Fields
    Definition Classes
    TupleShape → AnyShape → AmfObject
  54. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  55. def fromExternalSource: Boolean
    Definition Classes
    ShapeHelpers
  56. def fromLocal(): Boolean
    Definition Classes
    AmfElement
  57. def fromTypeExpression: Boolean
    Definition Classes
    ShapeHelpers
  58. def generateJsonSchema(element: AnyShape, options: ShapeRenderOptions = ShapeRenderOptions()): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  59. def generateRamlDatatype(element: AnyShape): String

    Generates a new RAML Data Type included in RAML 1.0 Library.

    Generates a new RAML Data Type included in RAML 1.0 Library.

    Attributes
    protected
    Definition Classes
    RamlDatatypeSerializer
  60. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  61. lazy val graph: Graph
    Definition Classes
    DomainElement
  62. val id: String
    Definition Classes
    AmfObject
  63. def ifShape: Shape
    Definition Classes
    Shape
  64. val inheritedIds: Seq[String]
    Definition Classes
    InheritanceChain
  65. def inherits: Seq[Shape]
    Definition Classes
    Shape
  66. def inlined: Boolean
    Definition Classes
    AnyShape
  67. 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
  68. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  69. def isLink: Boolean
    Definition Classes
    Linkable
  70. def isLinkToSource: Boolean
    Definition Classes
    ExternalSourceElement
  71. def isTrackedBy(trackId: String): Boolean
    Definition Classes
    AmfElement
  72. val isUnresolved: Boolean
    Definition Classes
    Linkable
  73. def items: Seq[Shape]
  74. def link[T](label: String, annotations: Annotations): T
    Definition Classes
    Linkable
  75. val linkAnnotations: Option[Annotations]
    Definition Classes
    Linkable
  76. def linkCopy(): TupleShape
    Definition Classes
    TupleShape → AnyShape → Linkable
  77. def linkLabel: StrField
    Definition Classes
    Linkable
  78. def linkSubType(shape: AnyShape): Unit
    Definition Classes
    InheritanceChain
  79. def linkTarget: Option[DomainElement]
    Definition Classes
    Linkable
  80. def location(): Option[String]
    Definition Classes
    ExternalSourceElement → AmfElement
  81. def maxItems: IntField
    Definition Classes
    DataArrangementShape
  82. val meta: AnyShapeModel
    Definition Classes
    TupleShape → AnyShape → AmfObject
  83. def minItems: IntField
    Definition Classes
    DataArrangementShape
  84. def name: StrField
    Definition Classes
    NamedDomainElement
  85. def nameField: Field
    Attributes
    protected
    Definition Classes
    Shape → NamedDomainElement
  86. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  87. def not: Shape
    Definition Classes
    Shape
  88. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  89. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  90. def or: Seq[Shape]
    Definition Classes
    Shape
  91. def parameterValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  92. def payloadValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  93. def payloadValidator(shape: Shape, env: Environment, validationMode: ValidationMode): PlatformPayloadValidator
    Attributes
    protected
    Definition Classes
    JsonSchemaSecrets
  94. def position(): Option[LexicalInformation]
    Definition Classes
    AmfElement
  95. def ramlSyntaxKey: String
    Definition Classes
    DataArrangementShape → AnyShape → Shape
  96. def raw: StrField
    Definition Classes
    ExternalSourceElement
  97. def readOnly: BoolField
    Definition Classes
    Shape
  98. val refAst: Option[YPart]
    Definition Classes
    Linkable
  99. val refCtx: Option[ParserContext]
    Definition Classes
    Linkable
  100. val refName: String
    Definition Classes
    Linkable
  101. def referenceId: StrField
    Definition Classes
    ExternalSourceElement
  102. def removeExamples(): Unit
    Definition Classes
    ExemplifiedDomainElement
  103. def resolveUnreferencedLink[T](label: String, annotations: Annotations, unresolved: T, supportsRecursion: Boolean): T
    Definition Classes
    Linkable
  104. def set(field: Field, value: AmfElement, annotations: Annotations): TupleShape.this.type
    Definition Classes
    AmfObject
  105. def set(field: Field, value: AmfElement): TupleShape.this.type
    Definition Classes
    AmfObject
  106. def set(field: Field, values: Seq[String]): TupleShape.this.type
    Definition Classes
    AmfObject
  107. def set(field: Field, value: Float): TupleShape.this.type
    Definition Classes
    AmfObject
  108. def set(field: Field, value: Double): TupleShape.this.type
    Definition Classes
    AmfObject
  109. def set(field: Field, value: Int): TupleShape.this.type
    Definition Classes
    AmfObject
  110. def set(field: Field, value: Boolean): TupleShape.this.type
    Definition Classes
    AmfObject
  111. def set(field: Field, value: String): TupleShape.this.type
    Definition Classes
    AmfObject
  112. def setArray(field: Field, values: Seq[AmfElement], annotations: Annotations): TupleShape.this.type
    Definition Classes
    AmfObject
  113. def setArray(field: Field, values: Seq[AmfElement]): TupleShape.this.type
    Definition Classes
    AmfObject
  114. def setArrayWithoutId(field: Field, values: Seq[AmfElement], annotations: Annotations): TupleShape.this.type
    Definition Classes
    AmfObject
  115. def setArrayWithoutId(field: Field, values: Seq[AmfElement]): TupleShape.this.type
    Definition Classes
    AmfObject
  116. def setDefaultStrValue(entry: YMapEntry): Unit
    Definition Classes
    ShapeHelper
  117. val shouldLink: Boolean
    Attributes
    protected
    Definition Classes
    Linkable
  118. final def simpleAdoption(parent: String): TupleShape.this.type
    Definition Classes
    AmfObject
  119. val subTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  120. val superTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  121. def supportsRecursion: BoolField
    Definition Classes
    Linkable
  122. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  123. def thenShape: Shape
    Definition Classes
    Shape
  124. def toFutureRef(resolve: (Linkable) ⇒ Unit): Unit
    Definition Classes
    Linkable
  125. def toJsonSchema: String
    Definition Classes
    AnyShape
  126. def toJsonSchema(element: AnyShape): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  127. def toRamlDatatype: String

    Delegates generation of a new RAML Data Type or returns cached one if it was generated before.

    Delegates generation of a new RAML Data Type or returns cached one if it was generated before.

    Definition Classes
    AnyShape
  128. def toRamlDatatype(element: AnyShape): String

    Delegates generation of a new RAML Data Type or returns cached one if it was generated before.

    Delegates generation of a new RAML Data Type or returns cached one if it was generated before.

    Attributes
    protected
    Definition Classes
    RamlDatatypeSerializer
  129. def trackedExample(trackId: String): Option[Example]
    Definition Classes
    AnyShape
  130. def typeExpression(eh: ErrorHandler): String
    Definition Classes
    ShapeHelpers
  131. def uniqueItems: BoolField
    Definition Classes
    DataArrangementShape
  132. def unresolved(refName: String, refAst: YPart, unresolvedSeverity: String)(implicit ctx: ParserContext): DomainElement with Linkable
    Definition Classes
    Linkable
  133. val unresolvedSeverity: String
    Definition Classes
    Linkable
  134. def validate(fragment: PayloadFragment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  135. def validate(fragment: PayloadFragment, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  136. def validate(payload: String): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  137. def validate(payload: String, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  138. def validateParameter(payload: String): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  139. def validateParameter(payload: String, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  140. def values: Seq[DataNode]
    Definition Classes
    Shape
  141. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  142. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  143. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  144. def withAnd(subShapes: Seq[Shape]): TupleShape.this.type
    Definition Classes
    Shape
  145. def withArrayItems(): ArrayShape
    Definition Classes
    DataArrangementShape
  146. def withClosedItems(closedItems: Boolean): TupleShape.this.type
  147. def withCollectionFormat(collectionFormat: Boolean): TupleShape.this.type
    Definition Classes
    DataArrangementShape
  148. def withComment(comment: String): TupleShape.this.type
    Definition Classes
    AnyShape
  149. def withCustomDomainProperties(extensions: Seq[DomainExtension]): TupleShape.this.type
    Definition Classes
    DomainElement
  150. def withCustomDomainProperty(extensions: DomainExtension): TupleShape.this.type
    Definition Classes
    DomainElement
  151. def withCustomShapeProperties(properties: Seq[ShapeExtension]): TupleShape.this.type
    Definition Classes
    Shape
  152. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  153. def withCustomShapePropertyDefinitions(propertyDefinitions: Seq[PropertyShape]): TupleShape.this.type
    Definition Classes
    Shape
  154. def withDefault(default: DataNode): TupleShape.this.type
    Definition Classes
    Shape
  155. def withDefaultStr(value: String): TupleShape.this.type
    Definition Classes
    Shape
  156. def withDeprecated(deprecated: Boolean): TupleShape.this.type
    Definition Classes
    Shape
  157. def withDescription(description: String): TupleShape.this.type
    Definition Classes
    Shape
  158. def withDisplayName(name: String): TupleShape.this.type
    Definition Classes
    Shape
  159. def withDocumentation(documentation: CreativeWork): TupleShape.this.type
    Definition Classes
    AnyShape
  160. def withElse(elseShape: Shape): TupleShape.this.type
    Definition Classes
    Shape
  161. def withExample(name: Option[String]): Example
    Definition Classes
    ExemplifiedDomainElement
  162. def withExamples(examples: Seq[Example]): TupleShape.this.type
    Definition Classes
    ExemplifiedDomainElement
  163. def withExtends(extend: Seq[DomainElement]): TupleShape.this.type
    Definition Classes
    DomainElement
  164. def withId(value: String): TupleShape.this.type
    Definition Classes
    AmfObject
  165. def withIf(ifShape: Shape): TupleShape.this.type
    Definition Classes
    Shape
  166. def withInherits(inherits: Seq[Shape]): TupleShape.this.type
    Definition Classes
    Shape
  167. def withItems(items: Seq[Shape]): TupleShape.this.type
  168. def withLinkLabel(label: String): TupleShape.this.type
    Definition Classes
    Linkable
  169. def withLinkTarget(target: DomainElement): TupleShape.this.type
    Definition Classes
    Linkable
  170. def withMaxItems(maxItems: Int): TupleShape.this.type
    Definition Classes
    DataArrangementShape
  171. def withMinItems(minItems: Int): TupleShape.this.type
    Definition Classes
    DataArrangementShape
  172. def withName(name: String, a: Annotations): TupleShape.this.type
    Definition Classes
    NamedDomainElement
  173. def withNodeItems(): NodeShape
    Definition Classes
    DataArrangementShape
  174. def withNot(shape: Shape): TupleShape.this.type
    Definition Classes
    Shape
  175. def withOr(subShapes: Seq[Shape]): TupleShape.this.type
    Definition Classes
    Shape
  176. def withReadOnly(readOnly: Boolean): TupleShape.this.type
    Definition Classes
    Shape
  177. def withReference(id: String): TupleShape.this.type
    Definition Classes
    ExternalSourceElement
  178. def withScalarItems(): ScalarShape
    Definition Classes
    DataArrangementShape
  179. def withSupportsRecursion(recursive: Boolean): TupleShape.this.type
    Definition Classes
    Linkable
  180. def withThen(thenShape: Shape): TupleShape.this.type
    Definition Classes
    Shape
  181. def withUniqueItems(uniqueItems: Boolean): TupleShape.this.type
    Definition Classes
    DataArrangementShape
  182. def withValues(values: Seq[DataNode]): TupleShape.this.type
    Definition Classes
    Shape
  183. def withWriteOnly(writeOnly: Boolean): TupleShape.this.type
    Definition Classes
    Shape
  184. def withXMLSerialization(xmlSerialization: XMLSerializer): TupleShape.this.type
    Definition Classes
    AnyShape
  185. def withXone(subShapes: Seq[Shape]): TupleShape.this.type
    Definition Classes
    Shape
  186. def writeOnly: BoolField
    Definition Classes
    Shape
  187. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
  188. def xone: Seq[Shape]
    Definition Classes
    Shape

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from DataArrangementShape

Inherited from AnyShape

Inherited from ExemplifiedDomainElement

Inherited from InheritanceChain

Inherited from ExternalSourceElement

Inherited from RamlDatatypeSerializer

Inherited from JsonSchemaSerializer

Inherited from ShapeHelpers

Inherited from JsonSchemaSecrets

Inherited from Shape

Inherited from ShapeHelper

Inherited from NamedDomainElement

Inherited from Linkable

Inherited from DomainElement

Inherited from AmfObject

Inherited from AmfElement

Inherited from AnyRef

Inherited from Any

Ungrouped