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, PlatformSecrets, 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. PlatformSecrets
  14. ShapeHelpers
  15. JsonSchemaSecrets
  16. Shape
  17. ShapeHelper
  18. NamedDomainElement
  19. Linkable
  20. DomainElement
  21. AmfObject
  22. AmfElement
  23. AnyRef
  24. 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, exec: BaseExecutionEnvironment): String
    Definition Classes
    AnyShape
  17. def buildJsonSchema(options: ShapeRenderOptions): String
    Definition Classes
    AnyShape
  18. def buildJsonSchema(exec: BaseExecutionEnvironment): String
    Definition Classes
    AnyShape
  19. def buildJsonSchema(): String
    Definition Classes
    AnyShape
  20. def buildRamlDatatype(exec: BaseExecutionEnvironment): String
    Definition Classes
    AnyShape
  21. def buildRamlDatatype: String

    Generates a new RAML Data Type.

    Generates a new RAML Data Type.

    Definition Classes
    AnyShape
  22. 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
  23. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  24. def cloneAllExamples(cloned: Shape, s: Shape): Unit
    Definition Classes
    ShapeHelpers
  25. def cloneShape(recursionErrorHandler: Option[ErrorHandler], withRecursionBase: Option[String] = None, traversal: ModelTraversalRegistry = ModelTraversalRegistry(), cloneExamples: Boolean = false): TupleShape.this.type
    Definition Classes
    ShapeHelpers
  26. def closedItems: BoolField
  27. val closureShapes: Set[Shape]
    Definition Classes
    Shape
  28. def collectCustomShapePropertyDefinitions(onlyInherited: Boolean, traversed: Set[String]): Seq[FacetsMap]
    Definition Classes
    Shape
  29. def collectionFormat: String
    Definition Classes
    DataArrangementShape
  30. def comment: StrField
    Definition Classes
    AnyShape
  31. 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
  32. def computeSubtypesClosure(): Seq[Shape]
    Attributes
    protected
    Definition Classes
    InheritanceChain
  33. def copyAnyShape(fields: Fields = fields, annotations: Annotations = annotations): AnyShape
    Definition Classes
    AnyShape
  34. def copyElement(a: Annotations): Linkable with DomainElement
    Definition Classes
    Linkable
  35. def copyElement(): Linkable with DomainElement
    Definition Classes
    Linkable
  36. def copyFields(recursionErrorHandler: Option[ErrorHandler], cloned: Shape, recursionBase: Option[String], traversal: ModelTraversalRegistry): Unit
    Attributes
    protected
    Definition Classes
    Shape
  37. def copyShape(): TupleShape.this.type
    Definition Classes
    AnyShape → Shape
  38. def copyShape(a: Annotations): TupleShape.this.type
    Definition Classes
    Shape
  39. def customDomainProperties: Seq[DomainExtension]
    Definition Classes
    DomainElement
  40. def customShapeProperties: Seq[ShapeExtension]
    Definition Classes
    Shape
  41. def customShapePropertyDefinitions: Seq[PropertyShape]
    Definition Classes
    Shape
  42. def default: DataNode
    Definition Classes
    Shape
  43. def defaultString: StrField
    Definition Classes
    Shape
  44. def deprecated: BoolField
    Definition Classes
    Shape
  45. def description: StrField
    Definition Classes
    Shape
  46. def displayName: StrField
    Definition Classes
    Shape
  47. def documentation: CreativeWork
    Definition Classes
    AnyShape
  48. def effectiveInherits: Seq[Shape]
    Definition Classes
    Shape
  49. def effectiveLinkTarget(links: Seq[String]): DomainElement
    Definition Classes
    Linkable
  50. def effectiveStructuralShapes: Seq[Shape]
    Definition Classes
    InheritanceChain
  51. def elseShape: Shape
    Definition Classes
    Shape
  52. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  53. def examples: Seq[Example]
    Definition Classes
    ExemplifiedDomainElement
  54. def extend: Seq[DomainElement]
    Definition Classes
    DomainElement
  55. def externalSourceID: Option[String]
    Definition Classes
    ShapeHelpers
  56. val fields: Fields
    Definition Classes
    TupleShape → AnyShape → AmfObject
  57. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  58. def fromExternalSource: Boolean
    Definition Classes
    ShapeHelpers
  59. def fromLocal(): Boolean
    Definition Classes
    AmfElement
  60. def fromTypeExpression: Boolean
    Definition Classes
    ShapeHelpers
  61. def generateJsonSchema(element: AnyShape, options: ShapeRenderOptions = ShapeRenderOptions(), exec: BaseExecutionEnvironment): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  62. def generateRamlDatatype(element: AnyShape, exec: BaseExecutionEnvironment): 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
  63. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  64. lazy val graph: Graph
    Definition Classes
    DomainElement
  65. val id: String
    Definition Classes
    AmfObject
  66. def ifShape: Shape
    Definition Classes
    Shape
  67. val inheritedIds: Seq[String]
    Definition Classes
    InheritanceChain
  68. def inherits: Seq[Shape]
    Definition Classes
    Shape
  69. def inlined: Boolean
    Definition Classes
    AnyShape
  70. 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
  71. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  72. def isLink: Boolean
    Definition Classes
    Linkable
  73. def isLinkToSource: Boolean
    Definition Classes
    ExternalSourceElement
  74. def isTrackedBy(trackId: String): Boolean
    Definition Classes
    AmfElement
  75. val isUnresolved: Boolean
    Definition Classes
    Linkable
  76. def items: Seq[Shape]
  77. def link[T](label: String, annotations: Annotations): T
    Definition Classes
    Linkable
  78. val linkAnnotations: Option[Annotations]
    Definition Classes
    Linkable
  79. def linkCopy(): TupleShape
    Definition Classes
    TupleShape → AnyShape → Linkable
  80. def linkLabel: StrField
    Definition Classes
    Linkable
  81. def linkSubType(shape: AnyShape): Unit
    Definition Classes
    InheritanceChain
  82. def linkTarget: Option[DomainElement]
    Definition Classes
    Linkable
  83. def location(): Option[String]
    Definition Classes
    ExternalSourceElement → AmfElement
  84. def maxItems: IntField
    Definition Classes
    DataArrangementShape
  85. val meta: AnyShapeModel
    Definition Classes
    TupleShape → AnyShape → AmfObject
  86. def minItems: IntField
    Definition Classes
    DataArrangementShape
  87. def name: StrField
    Definition Classes
    NamedDomainElement
  88. def nameField: Field
    Attributes
    protected
    Definition Classes
    Shape → NamedDomainElement
  89. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  90. def not: Shape
    Definition Classes
    Shape
  91. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  92. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  93. def or: Seq[Shape]
    Definition Classes
    Shape
  94. def parameterValidator(mediaType: String, exec: BaseExecutionEnvironment): Option[PayloadValidator]
    Definition Classes
    AnyShape
  95. def parameterValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  96. def payloadValidator(mediaType: String, exec: BaseExecutionEnvironment): Option[PayloadValidator]
    Definition Classes
    AnyShape
  97. def payloadValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  98. def payloadValidator(shape: Shape, env: Environment, validationMode: ValidationMode): PlatformPayloadValidator
    Attributes
    protected
    Definition Classes
    JsonSchemaSecrets
  99. val platform: Platform
    Definition Classes
    PlatformSecrets
  100. def position(): Option[LexicalInformation]
    Definition Classes
    AmfElement
  101. def ramlSyntaxKey: String
    Definition Classes
    DataArrangementShape → AnyShape → Shape
  102. def raw: StrField
    Definition Classes
    ExternalSourceElement
  103. def readOnly: BoolField
    Definition Classes
    Shape
  104. val refAst: Option[YPart]
    Definition Classes
    Linkable
  105. val refCtx: Option[ParserContext]
    Definition Classes
    Linkable
  106. val refName: String
    Definition Classes
    Linkable
  107. def referenceId: StrField
    Definition Classes
    ExternalSourceElement
  108. def removeExamples(): Unit
    Definition Classes
    ExemplifiedDomainElement
  109. def resolveUnreferencedLink[T](label: String, annotations: Annotations, unresolved: T, supportsRecursion: Boolean): T
    Definition Classes
    Linkable
  110. def set(field: Field, value: AmfElement, annotations: Annotations): TupleShape.this.type
    Definition Classes
    AmfObject
  111. def set(field: Field, value: AmfElement): TupleShape.this.type
    Definition Classes
    AmfObject
  112. def set(field: Field, values: Seq[String]): TupleShape.this.type
    Definition Classes
    AmfObject
  113. def set(field: Field, value: Float): TupleShape.this.type
    Definition Classes
    AmfObject
  114. def set(field: Field, value: Double): TupleShape.this.type
    Definition Classes
    AmfObject
  115. def set(field: Field, value: Int): TupleShape.this.type
    Definition Classes
    AmfObject
  116. def set(field: Field, value: Boolean): TupleShape.this.type
    Definition Classes
    AmfObject
  117. def set(field: Field, value: String): TupleShape.this.type
    Definition Classes
    AmfObject
  118. def setArray(field: Field, values: Seq[AmfElement], annotations: Annotations): TupleShape.this.type
    Definition Classes
    AmfObject
  119. def setArray(field: Field, values: Seq[AmfElement]): TupleShape.this.type
    Definition Classes
    AmfObject
  120. def setArrayWithoutId(field: Field, values: Seq[AmfElement], annotations: Annotations): TupleShape.this.type
    Definition Classes
    AmfObject
  121. def setArrayWithoutId(field: Field, values: Seq[AmfElement]): TupleShape.this.type
    Definition Classes
    AmfObject
  122. def setDefaultStrValue(entry: YMapEntry): Unit
    Definition Classes
    ShapeHelper
  123. val shouldLink: Boolean
    Attributes
    protected
    Definition Classes
    Linkable
  124. final def simpleAdoption(parent: String): TupleShape.this.type
    Definition Classes
    AmfObject
  125. val subTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  126. val superTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  127. def supportsRecursion: BoolField
    Definition Classes
    Linkable
  128. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  129. def thenShape: Shape
    Definition Classes
    Shape
  130. def toFutureRef(resolve: (Linkable) ⇒ Unit): Unit
    Definition Classes
    Linkable
  131. def toJsonSchema(exec: BaseExecutionEnvironment): String
    Definition Classes
    AnyShape
  132. def toJsonSchema: String
    Definition Classes
    AnyShape
  133. def toJsonSchema(element: AnyShape, exec: BaseExecutionEnvironment): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  134. def toRamlDatatype(exec: BaseExecutionEnvironment): String
    Definition Classes
    AnyShape
  135. 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
  136. def toRamlDatatype(element: AnyShape, exec: BaseExecutionEnvironment): 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
  137. def trackedExample(trackId: String): Option[Example]
    Definition Classes
    AnyShape
  138. def typeExpression(eh: ErrorHandler): String
    Definition Classes
    ShapeHelpers
  139. def uniqueItems: BoolField
    Definition Classes
    DataArrangementShape
  140. def unresolved(refName: String, refAst: YPart, unresolvedSeverity: String)(implicit ctx: ParserContext): DomainElement with Linkable
    Definition Classes
    Linkable
  141. val unresolvedSeverity: String
    Definition Classes
    Linkable
  142. def validate(fragment: PayloadFragment, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  143. def validate(fragment: PayloadFragment, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  144. def validate(fragment: PayloadFragment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  145. def validate(fragment: PayloadFragment, env: Environment, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  146. def validate(payload: String, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  147. def validate(payload: String, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  148. def validate(payload: String): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  149. def validate(payload: String, env: Environment, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  150. def validateParameter(payload: String, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  151. def validateParameter(payload: String, env: Environment = Environment(), exec: BaseExecutionEnvironment = ...): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  152. def values: Seq[DataNode]
    Definition Classes
    Shape
  153. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  154. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  155. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  156. def withAnd(subShapes: Seq[Shape]): TupleShape.this.type
    Definition Classes
    Shape
  157. def withArrayItems(): ArrayShape
    Definition Classes
    DataArrangementShape
  158. def withClosedItems(closedItems: Boolean): TupleShape.this.type
  159. def withCollectionFormat(collectionFormat: Boolean): TupleShape.this.type
    Definition Classes
    DataArrangementShape
  160. def withComment(comment: String): TupleShape.this.type
    Definition Classes
    AnyShape
  161. def withCustomDomainProperties(extensions: Seq[DomainExtension]): TupleShape.this.type
    Definition Classes
    DomainElement
  162. def withCustomDomainProperty(extensions: DomainExtension): TupleShape.this.type
    Definition Classes
    DomainElement
  163. def withCustomShapeProperties(properties: Seq[ShapeExtension]): TupleShape.this.type
    Definition Classes
    Shape
  164. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  165. def withCustomShapePropertyDefinitions(propertyDefinitions: Seq[PropertyShape]): TupleShape.this.type
    Definition Classes
    Shape
  166. def withDefault(default: DataNode): TupleShape.this.type
    Definition Classes
    Shape
  167. def withDefaultStr(value: String): TupleShape.this.type
    Definition Classes
    Shape
  168. def withDeprecated(deprecated: Boolean): TupleShape.this.type
    Definition Classes
    Shape
  169. def withDescription(description: String): TupleShape.this.type
    Definition Classes
    Shape
  170. def withDisplayName(name: String): TupleShape.this.type
    Definition Classes
    Shape
  171. def withDocumentation(documentation: CreativeWork): TupleShape.this.type
    Definition Classes
    AnyShape
  172. def withElse(elseShape: Shape): TupleShape.this.type
    Definition Classes
    Shape
  173. def withExample(name: Option[String]): Example
    Definition Classes
    ExemplifiedDomainElement
  174. def withExamples(examples: Seq[Example]): TupleShape.this.type
    Definition Classes
    ExemplifiedDomainElement
  175. def withExtends(extend: Seq[DomainElement]): TupleShape.this.type
    Definition Classes
    DomainElement
  176. def withId(value: String): TupleShape.this.type
    Definition Classes
    AmfObject
  177. def withIf(ifShape: Shape): TupleShape.this.type
    Definition Classes
    Shape
  178. def withInherits(inherits: Seq[Shape]): TupleShape.this.type
    Definition Classes
    Shape
  179. def withItems(items: Seq[Shape]): TupleShape.this.type
  180. def withLinkLabel(label: String): TupleShape.this.type
    Definition Classes
    Linkable
  181. def withLinkTarget(target: DomainElement): TupleShape.this.type
    Definition Classes
    Linkable
  182. def withMaxItems(maxItems: Int): TupleShape.this.type
    Definition Classes
    DataArrangementShape
  183. def withMinItems(minItems: Int): TupleShape.this.type
    Definition Classes
    DataArrangementShape
  184. def withName(name: String, a: Annotations): TupleShape.this.type
    Definition Classes
    NamedDomainElement
  185. def withNodeItems(): NodeShape
    Definition Classes
    DataArrangementShape
  186. def withNot(shape: Shape): TupleShape.this.type
    Definition Classes
    Shape
  187. def withOr(subShapes: Seq[Shape]): TupleShape.this.type
    Definition Classes
    Shape
  188. def withReadOnly(readOnly: Boolean): TupleShape.this.type
    Definition Classes
    Shape
  189. def withReference(id: String): TupleShape.this.type
    Definition Classes
    ExternalSourceElement
  190. def withScalarItems(): ScalarShape
    Definition Classes
    DataArrangementShape
  191. def withSupportsRecursion(recursive: Boolean): TupleShape.this.type
    Definition Classes
    Linkable
  192. def withThen(thenShape: Shape): TupleShape.this.type
    Definition Classes
    Shape
  193. def withUniqueItems(uniqueItems: Boolean): TupleShape.this.type
    Definition Classes
    DataArrangementShape
  194. def withValues(values: Seq[DataNode]): TupleShape.this.type
    Definition Classes
    Shape
  195. def withWriteOnly(writeOnly: Boolean): TupleShape.this.type
    Definition Classes
    Shape
  196. def withXMLSerialization(xmlSerialization: XMLSerializer): TupleShape.this.type
    Definition Classes
    AnyShape
  197. def withXone(subShapes: Seq[Shape]): TupleShape.this.type
    Definition Classes
    Shape
  198. def writeOnly: BoolField
    Definition Classes
    Shape
  199. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
  200. 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 PlatformSecrets

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