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

    Generates a new RAML Data Type.

    Generates a new RAML Data Type.

    Definition Classes
    AnyShape
  17. 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
    ArrayShape → AnyShape → Linkable
  18. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  19. def cloneAllExamples(cloned: Shape, s: Shape): Unit
    Definition Classes
    ShapeHelpers
  20. def cloneShape(recursionErrorHandler: Option[ErrorHandler], withRecursionBase: Option[String] = None, traversal: ModelTraversalRegistry = ModelTraversalRegistry(), cloneExamples: Boolean = false): ArrayShape.this.type
    Definition Classes
    ShapeHelpers
  21. def collectCustomShapePropertyDefinitions(onlyInherited: Boolean, traversed: Set[String]): Seq[FacetsMap]
    Definition Classes
    Shape
  22. def collectionFormat: String
    Definition Classes
    DataArrangementShape
  23. def comment: StrField
    Definition Classes
    AnyShape
  24. 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
  25. def computeSubtypesClosure(): Seq[Shape]
    Attributes
    protected
    Definition Classes
    InheritanceChain
  26. def contains: Shape
  27. def copyAnyShape(fields: Fields = fields, annotations: Annotations = annotations): AnyShape
    Definition Classes
    AnyShape
  28. def copyElement(a: Annotations): Linkable with DomainElement
    Definition Classes
    Linkable
  29. def copyElement(): Linkable with DomainElement
    Definition Classes
    Linkable
  30. def copyFields(recursionErrorHandler: Option[ErrorHandler], cloned: Shape, recursionBase: Option[String], traversal: ModelTraversalRegistry): Unit
    Attributes
    protected
    Definition Classes
    Shape
  31. def copyShape(): ArrayShape.this.type
    Definition Classes
    AnyShape → Shape
  32. def copyShape(a: Annotations): ArrayShape.this.type
    Definition Classes
    Shape
  33. def customDomainProperties: Seq[DomainExtension]
    Definition Classes
    DomainElement
  34. def customShapeProperties: Seq[ShapeExtension]
    Definition Classes
    Shape
  35. def customShapePropertyDefinitions: Seq[PropertyShape]
    Definition Classes
    Shape
  36. def default: DataNode
    Definition Classes
    Shape
  37. def defaultString: StrField
    Definition Classes
    Shape
  38. def deprecated: BoolField
    Definition Classes
    Shape
  39. def description: StrField
    Definition Classes
    Shape
  40. def displayName: StrField
    Definition Classes
    Shape
  41. def documentation: CreativeWork
    Definition Classes
    AnyShape
  42. def documentations: Seq[CreativeWork]
    Definition Classes
    AnyShape → DocumentedElement
  43. def effectiveInherits: Seq[Shape]
    Definition Classes
    Shape
  44. def effectiveLinkTarget(links: Seq[String]): DomainElement
    Definition Classes
    Linkable
  45. def effectiveStructuralShapes: Seq[Shape]
    Definition Classes
    InheritanceChain
  46. def elseShape: Shape
    Definition Classes
    Shape
  47. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  48. def examples: Seq[Example]
    Definition Classes
    ExemplifiedDomainElement
  49. def extend: Seq[DomainElement]
    Definition Classes
    DomainElement
  50. def externalSourceID: Option[String]
    Definition Classes
    ShapeHelpers
  51. val fields: Fields
    Definition Classes
    ArrayShape → AnyShape → AmfObject
  52. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  53. def fromExternalSource: Boolean
    Definition Classes
    ShapeHelpers
  54. def fromLocal(): Boolean
    Definition Classes
    AmfElement
  55. def fromTypeExpression: Boolean
    Definition Classes
    ShapeHelpers
  56. def generateJsonSchema(element: AnyShape, options: ShapeRenderOptions = ShapeRenderOptions(), exec: BaseExecutionEnvironment): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  57. 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
  58. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  59. lazy val graph: Graph
    Definition Classes
    DomainElement
  60. def hasItems: Boolean
  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: Shape
  75. def link[T](label: String, annotations: Annotations): T
    Definition Classes
    Linkable
  76. val linkAnnotations: Option[Annotations]
    Definition Classes
    Linkable
  77. def linkCopy(): ArrayShape
    Definition Classes
    ArrayShape → 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 maxContains: Int
  83. def maxItems: IntField
    Definition Classes
    DataArrangementShape
  84. val meta: AnyShapeModel
    Definition Classes
    ArrayShape → AnyShape → AmfObject
  85. def minContains: Int
  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): ArrayShape.this.type
    Definition Classes
    AmfObject
  111. def set(field: Field, value: AmfElement): ArrayShape.this.type
    Definition Classes
    AmfObject
  112. def set(field: Field, values: Seq[String]): ArrayShape.this.type
    Definition Classes
    AmfObject
  113. def set(field: Field, value: Float): ArrayShape.this.type
    Definition Classes
    AmfObject
  114. def set(field: Field, value: Double): ArrayShape.this.type
    Definition Classes
    AmfObject
  115. def set(field: Field, value: Int): ArrayShape.this.type
    Definition Classes
    AmfObject
  116. def set(field: Field, value: Boolean): ArrayShape.this.type
    Definition Classes
    AmfObject
  117. def set(field: Field, value: String): ArrayShape.this.type
    Definition Classes
    AmfObject
  118. def setArray(field: Field, values: Seq[AmfElement], annotations: Annotations): ArrayShape.this.type
    Definition Classes
    AmfObject
  119. def setArray(field: Field, values: Seq[AmfElement]): ArrayShape.this.type
    Definition Classes
    AmfObject
  120. def setArrayWithoutId(field: Field, values: Seq[AmfElement], annotations: Annotations): ArrayShape.this.type
    Definition Classes
    AmfObject
  121. def setArrayWithoutId(field: Field, values: Seq[AmfElement]): ArrayShape.this.type
    Definition Classes
    AmfObject
  122. def setDefaultStrValue(entry: YMapEntry): Unit
    Definition Classes
    ShapeHelper
  123. def setWithoutId(field: Field, value: AmfElement, annotations: Annotations): ArrayShape.this.type
    Definition Classes
    AmfObject
  124. val shouldLink: Boolean
    Attributes
    protected
    Definition Classes
    Linkable
  125. final def simpleAdoption(parent: String): ArrayShape.this.type
    Definition Classes
    AmfObject
  126. val subTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  127. val superTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  128. def supportsRecursion: BoolField
    Definition Classes
    Linkable
  129. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  130. def thenShape: Shape
    Definition Classes
    Shape
  131. def toFutureRef(resolve: (Linkable) ⇒ Unit): Unit
    Definition Classes
    Linkable
  132. def toJsonSchema(exec: BaseExecutionEnvironment = ...): String
    Definition Classes
    AnyShape
  133. def toJsonSchema(element: AnyShape, exec: BaseExecutionEnvironment): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  134. def toMatrixShape: MatrixShape
  135. def toMatrixShapeWithoutId: MatrixShape
  136. 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
  137. 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
  138. def trackedExample(trackId: String): Option[Example]
    Definition Classes
    AnyShape
  139. def typeExpression(eh: ErrorHandler): String
    Definition Classes
    ShapeHelpers
  140. def unevaluatedItems: Boolean
  141. def unevaluatedItemsSchema: Shape
  142. def uniqueItems: BoolField
    Definition Classes
    DataArrangementShape
  143. def unresolved(refName: String, refAst: YPart, unresolvedSeverity: String)(implicit ctx: ParserContext): DomainElement with Linkable
    Definition Classes
    Linkable
  144. val unresolvedSeverity: String
    Definition Classes
    Linkable
  145. def validate(fragment: PayloadFragment, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  146. def validate(fragment: PayloadFragment, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  147. def validate(fragment: PayloadFragment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  148. def validate(fragment: PayloadFragment, env: Environment, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  149. def validate(payload: String, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  150. def validate(payload: String, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  151. def validate(payload: String): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  152. def validate(payload: String, env: Environment, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  153. def validateParameter(payload: String, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  154. def validateParameter(payload: String, env: Environment = Environment(), exec: BaseExecutionEnvironment = ...): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  155. def values: Seq[DataNode]
    Definition Classes
    Shape
  156. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  157. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  158. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  159. def withAnd(subShapes: Seq[Shape]): ArrayShape.this.type
    Definition Classes
    Shape
  160. def withArrayItems(): ArrayShape
    Definition Classes
    DataArrangementShape
  161. def withCollectionFormat(collectionFormat: Boolean): ArrayShape.this.type
    Definition Classes
    DataArrangementShape
  162. def withComment(comment: String): ArrayShape.this.type
    Definition Classes
    AnyShape
  163. def withContains(contains: Shape): ArrayShape.this.type
  164. def withCustomDomainProperties(extensions: Seq[DomainExtension]): ArrayShape.this.type
    Definition Classes
    DomainElement
  165. def withCustomDomainProperty(extensions: DomainExtension): ArrayShape.this.type
    Definition Classes
    DomainElement
  166. def withCustomShapeProperties(properties: Seq[ShapeExtension]): ArrayShape.this.type
    Definition Classes
    Shape
  167. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  168. def withCustomShapePropertyDefinitions(propertyDefinitions: Seq[PropertyShape]): ArrayShape.this.type
    Definition Classes
    Shape
  169. def withDefault(default: DataNode): ArrayShape.this.type
    Definition Classes
    Shape
  170. def withDefaultStr(value: String): ArrayShape.this.type
    Definition Classes
    Shape
  171. def withDeprecated(deprecated: Boolean): ArrayShape.this.type
    Definition Classes
    Shape
  172. def withDescription(description: String): ArrayShape.this.type
    Definition Classes
    Shape
  173. def withDisplayName(name: String): ArrayShape.this.type
    Definition Classes
    Shape
  174. def withDocumentation(documentation: CreativeWork): ArrayShape.this.type
    Definition Classes
    AnyShape
  175. def withElse(elseShape: Shape): ArrayShape.this.type
    Definition Classes
    Shape
  176. def withExample(name: Option[String]): Example
    Definition Classes
    ExemplifiedDomainElement
  177. def withExamples(examples: Seq[Example]): ArrayShape.this.type
    Definition Classes
    ExemplifiedDomainElement
  178. def withExtends(extend: Seq[DomainElement]): ArrayShape.this.type
    Definition Classes
    DomainElement
  179. def withId(value: String): ArrayShape.this.type
    Definition Classes
    AmfObject
  180. def withIf(ifShape: Shape): ArrayShape.this.type
    Definition Classes
    Shape
  181. def withInherits(inherits: Seq[Shape]): ArrayShape.this.type
    Definition Classes
    Shape
  182. def withIsExternalLink(isReference: Boolean): ArrayShape.this.type
    Definition Classes
    DomainElement
  183. def withItems(items: Shape): ArrayShape.this.type
  184. def withLinkLabel(label: String): ArrayShape.this.type
    Definition Classes
    Linkable
  185. def withLinkTarget(target: DomainElement): ArrayShape.this.type
    Definition Classes
    Linkable
  186. def withMaxContains(maxTimes: Int): ArrayShape.this.type
  187. def withMaxItems(maxItems: Int): ArrayShape.this.type
    Definition Classes
    DataArrangementShape
  188. def withMinContains(minTimes: Int): ArrayShape.this.type
  189. def withMinItems(minItems: Int): ArrayShape.this.type
    Definition Classes
    DataArrangementShape
  190. def withName(name: String, a: Annotations): ArrayShape.this.type
    Definition Classes
    NamedDomainElement
  191. def withNodeItems(): NodeShape
    Definition Classes
    DataArrangementShape
  192. def withNot(shape: Shape): ArrayShape.this.type
    Definition Classes
    Shape
  193. def withOr(subShapes: Seq[Shape]): ArrayShape.this.type
    Definition Classes
    Shape
  194. def withReadOnly(readOnly: Boolean): ArrayShape.this.type
    Definition Classes
    Shape
  195. def withReference(id: String): ArrayShape.this.type
    Definition Classes
    ExternalSourceElement
  196. def withScalarItems(): ScalarShape
    Definition Classes
    DataArrangementShape
  197. def withSupportsRecursion(recursive: Boolean): ArrayShape.this.type
    Definition Classes
    Linkable
  198. def withThen(thenShape: Shape): ArrayShape.this.type
    Definition Classes
    Shape
  199. def withUnevaluatedItems(value: Boolean): ArrayShape.this.type
  200. def withUnevaluatedItemsSchema(schema: Shape): ArrayShape.this.type
  201. def withUniqueItems(uniqueItems: Boolean): ArrayShape.this.type
    Definition Classes
    DataArrangementShape
  202. def withValues(values: Seq[DataNode]): ArrayShape.this.type
    Definition Classes
    Shape
  203. def withWriteOnly(writeOnly: Boolean): ArrayShape.this.type
    Definition Classes
    Shape
  204. def withXMLSerialization(xmlSerialization: XMLSerializer): ArrayShape.this.type
    Definition Classes
    AnyShape
  205. def withXone(subShapes: Seq[Shape]): ArrayShape.this.type
    Definition Classes
    Shape
  206. def writeOnly: BoolField
    Definition Classes
    Shape
  207. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
  208. 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