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

Linear Supertypes
Serializable, Serializable, Product, Equals, DataArrangementShape, AnyShape, ExemplifiedDomainElement, DocumentedElement, 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. DocumentedElement
  10. InheritanceChain
  11. ExternalSourceElement
  12. RamlDatatypeSerializer
  13. JsonSchemaSerializer
  14. PlatformSecrets
  15. ShapeHelpers
  16. JsonSchemaSecrets
  17. Shape
  18. ShapeHelper
  19. NamedDomainElement
  20. Linkable
  21. DomainElement
  22. AmfObject
  23. AmfElement
  24. AnyRef
  25. 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 = ShapeRenderOptions(), exec: BaseExecutionEnvironment = ...): String
    Definition Classes
    AnyShape
  17. def buildRamlDatatype(exec: BaseExecutionEnvironment = ...): String

    Generates a new RAML Data Type.

    Generates a new RAML Data Type.

    Definition Classes
    AnyShape
  18. 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
  19. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  20. def cloneAllExamples(cloned: Shape, s: Shape): Unit
    Definition Classes
    ShapeHelpers
  21. def cloneShape(recursionErrorHandler: Option[ErrorHandler], withRecursionBase: Option[String] = None, traversal: ModelTraversalRegistry = ModelTraversalRegistry(), cloneExamples: Boolean = false): TupleShape.this.type
    Definition Classes
    ShapeHelpers
  22. def closedItems: BoolField
  23. def collectCustomShapePropertyDefinitions(onlyInherited: Boolean, traversed: Set[String]): Seq[FacetsMap]
    Definition Classes
    Shape
  24. def collectionFormat: String
    Definition Classes
    DataArrangementShape
  25. def comment: StrField
    Definition Classes
    AnyShape
  26. 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
  27. def computeSubtypesClosure(): Seq[Shape]
    Attributes
    protected
    Definition Classes
    InheritanceChain
  28. def copyAnyShape(fields: Fields = fields, annotations: Annotations = annotations): AnyShape
    Definition Classes
    AnyShape
  29. def copyElement(a: Annotations): Linkable with DomainElement
    Definition Classes
    Linkable
  30. def copyElement(): Linkable with DomainElement
    Definition Classes
    Linkable
  31. def copyFields(recursionErrorHandler: Option[ErrorHandler], cloned: Shape, recursionBase: Option[String], traversal: ModelTraversalRegistry): Unit
    Attributes
    protected
    Definition Classes
    Shape
  32. def copyShape(): TupleShape.this.type
    Definition Classes
    AnyShape → Shape
  33. def copyShape(a: Annotations): TupleShape.this.type
    Definition Classes
    Shape
  34. def customDomainProperties: Seq[DomainExtension]
    Definition Classes
    DomainElement
  35. def customShapeProperties: Seq[ShapeExtension]
    Definition Classes
    Shape
  36. def customShapePropertyDefinitions: Seq[PropertyShape]
    Definition Classes
    Shape
  37. def default: DataNode
    Definition Classes
    Shape
  38. def defaultString: StrField
    Definition Classes
    Shape
  39. def deprecated: BoolField
    Definition Classes
    Shape
  40. def description: StrField
    Definition Classes
    Shape
  41. def displayName: StrField
    Definition Classes
    Shape
  42. def documentation: CreativeWork
    Definition Classes
    AnyShape
  43. def documentations: Seq[CreativeWork]
    Definition Classes
    AnyShape → DocumentedElement
  44. def effectiveInherits: Seq[Shape]
    Definition Classes
    Shape
  45. def effectiveLinkTarget(links: Seq[String]): DomainElement
    Definition Classes
    Linkable
  46. def effectiveStructuralShapes: Seq[Shape]
    Definition Classes
    InheritanceChain
  47. def elseShape: Shape
    Definition Classes
    Shape
  48. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  49. def examples: Seq[Example]
    Definition Classes
    ExemplifiedDomainElement
  50. def extend: Seq[DomainElement]
    Definition Classes
    DomainElement
  51. def externalSourceID: Option[String]
    Definition Classes
    ShapeHelpers
  52. val fields: Fields
    Definition Classes
    TupleShape → AnyShape → AmfObject
  53. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  54. def fromExternalSource: Boolean
    Definition Classes
    ShapeHelpers
  55. def fromLocal(): Boolean
    Definition Classes
    AmfElement
  56. def fromTypeExpression: Boolean
    Definition Classes
    ShapeHelpers
  57. def generateJsonSchema(element: AnyShape, options: ShapeRenderOptions = ShapeRenderOptions(), exec: BaseExecutionEnvironment): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  58. 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
  59. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  60. lazy val graph: Graph
    Definition Classes
    DomainElement
  61. val id: String
    Definition Classes
    AmfObject
  62. def ifShape: Shape
    Definition Classes
    Shape
  63. val inheritedIds: Seq[String]
    Definition Classes
    InheritanceChain
  64. def inherits: Seq[Shape]
    Definition Classes
    Shape
  65. def inlined: Boolean
    Definition Classes
    AnyShape
  66. def isAnyType: 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. def isExternalLink: BoolField
    Definition Classes
    DomainElement
  69. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  70. def isLink: Boolean
    Definition Classes
    Linkable
  71. def isLinkToSource: Boolean
    Definition Classes
    ExternalSourceElement
  72. def isTrackedBy(trackId: String): Boolean
    Definition Classes
    AmfElement
  73. val isUnresolved: Boolean
    Definition Classes
    Linkable
  74. def items: Seq[Shape]
  75. def link[T](label: String, annotations: Annotations): T
    Definition Classes
    Linkable
  76. val linkAnnotations: Option[Annotations]
    Definition Classes
    Linkable
  77. def linkCopy(): TupleShape
    Definition Classes
    TupleShape → AnyShape → Linkable
  78. def linkLabel: StrField
    Definition Classes
    Linkable
  79. def linkSubType(shape: AnyShape): Unit
    Definition Classes
    InheritanceChain
  80. def linkTarget: Option[DomainElement]
    Definition Classes
    Linkable
  81. def location(): Option[String]
    Definition Classes
    ExternalSourceElement → AmfElement
  82. def maxItems: IntField
    Definition Classes
    DataArrangementShape
  83. val meta: AnyShapeModel
    Definition Classes
    TupleShape → AnyShape → AmfObject
  84. def minItems: IntField
    Definition Classes
    DataArrangementShape
  85. def name: StrField
    Definition Classes
    NamedDomainElement
  86. def nameField: Field
    Attributes
    protected
    Definition Classes
    Shape → NamedDomainElement
  87. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  88. def not: Shape
    Definition Classes
    Shape
  89. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  90. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  91. def or: Seq[Shape]
    Definition Classes
    Shape
  92. def parameterValidator(mediaType: String, exec: BaseExecutionEnvironment): Option[PayloadValidator]
    Definition Classes
    AnyShape
  93. def parameterValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  94. def payloadValidator(mediaType: String, exec: BaseExecutionEnvironment): Option[PayloadValidator]
    Definition Classes
    AnyShape
  95. def payloadValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  96. def payloadValidator(shape: Shape, env: Environment, validationMode: ValidationMode): PlatformPayloadValidator
    Attributes
    protected
    Definition Classes
    JsonSchemaSecrets
  97. val platform: Platform
    Definition Classes
    PlatformSecrets
  98. def position(): Option[LexicalInformation]
    Definition Classes
    AmfElement
  99. def ramlSyntaxKey: String
    Definition Classes
    DataArrangementShape → AnyShape → Shape
  100. def raw: StrField
    Definition Classes
    ExternalSourceElement
  101. def readOnly: BoolField
    Definition Classes
    Shape
  102. val refAst: Option[YPart]
    Definition Classes
    Linkable
  103. val refCtx: Option[ParserContext]
    Definition Classes
    Linkable
  104. val refName: String
    Definition Classes
    Linkable
  105. def referenceId: StrField
    Definition Classes
    ExternalSourceElement
  106. def removeExamples(): Unit
    Definition Classes
    ExemplifiedDomainElement
  107. def resolveUnreferencedLink[T](label: String, annotations: Annotations, unresolved: T, supportsRecursion: Boolean): T
    Definition Classes
    Linkable
  108. def set(field: Field, value: AmfElement, annotations: Annotations): TupleShape.this.type
    Definition Classes
    AmfObject
  109. def set(field: Field, value: AmfElement): TupleShape.this.type
    Definition Classes
    AmfObject
  110. def set(field: Field, values: Seq[String]): TupleShape.this.type
    Definition Classes
    AmfObject
  111. def set(field: Field, value: Float): TupleShape.this.type
    Definition Classes
    AmfObject
  112. def set(field: Field, value: Double): TupleShape.this.type
    Definition Classes
    AmfObject
  113. def set(field: Field, value: Int): TupleShape.this.type
    Definition Classes
    AmfObject
  114. def set(field: Field, value: Boolean): TupleShape.this.type
    Definition Classes
    AmfObject
  115. def set(field: Field, value: String): TupleShape.this.type
    Definition Classes
    AmfObject
  116. def setArray(field: Field, values: Seq[AmfElement], annotations: Annotations): TupleShape.this.type
    Definition Classes
    AmfObject
  117. def setArray(field: Field, values: Seq[AmfElement]): TupleShape.this.type
    Definition Classes
    AmfObject
  118. def setArrayWithoutId(field: Field, values: Seq[AmfElement], annotations: Annotations): TupleShape.this.type
    Definition Classes
    AmfObject
  119. def setArrayWithoutId(field: Field, values: Seq[AmfElement]): TupleShape.this.type
    Definition Classes
    AmfObject
  120. def setDefaultStrValue(entry: YMapEntry): Unit
    Definition Classes
    ShapeHelper
  121. def setWithoutId(field: Field, value: AmfElement, annotations: Annotations): TupleShape.this.type
    Definition Classes
    AmfObject
  122. val shouldLink: Boolean
    Attributes
    protected
    Definition Classes
    Linkable
  123. final def simpleAdoption(parent: String): TupleShape.this.type
    Definition Classes
    AmfObject
  124. val subTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  125. val superTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  126. def supportsRecursion: BoolField
    Definition Classes
    Linkable
  127. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  128. def thenShape: Shape
    Definition Classes
    Shape
  129. def toFutureRef(resolve: (Linkable) ⇒ Unit): Unit
    Definition Classes
    Linkable
  130. def toJsonSchema(exec: BaseExecutionEnvironment = ...): String
    Definition Classes
    AnyShape
  131. def toJsonSchema(element: AnyShape, exec: BaseExecutionEnvironment): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  132. def toRamlDatatype(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.

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

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