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

Linear Supertypes
Serializable, Serializable, Product, Equals, DataArrangementShape, AnyShape, ValidatorAware, 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. ValidatorAware
  9. ExemplifiedDomainElement
  10. DocumentedElement
  11. InheritanceChain
  12. ExternalSourceElement
  13. RamlDatatypeSerializer
  14. JsonSchemaSerializer
  15. PlatformSecrets
  16. ShapeHelpers
  17. JsonSchemaSecrets
  18. Shape
  19. ShapeHelper
  20. NamedDomainElement
  21. Linkable
  22. DomainElement
  23. AmfObject
  24. AmfElement
  25. AnyRef
  26. 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 generateJsonSchema(element: AnyShape, options: ShapeRenderOptions = ShapeRenderOptions(), exec: BaseExecutionEnvironment): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  56. 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
  57. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  58. lazy val graph: Graph
    Definition Classes
    DomainElement
  59. def hasItems: Boolean
  60. val id: String
    Definition Classes
    AmfObject
  61. def ifShape: Shape
    Definition Classes
    Shape
  62. val inheritedIds: Seq[String]
    Definition Classes
    InheritanceChain
  63. def inherits: Seq[Shape]
    Definition Classes
    Shape
  64. def inlined: Boolean
    Definition Classes
    AnyShape
  65. def isAnyType: Boolean
    Definition Classes
    AnyShape
  66. 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
  67. def isExternalLink: BoolField
    Definition Classes
    DomainElement
  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: Shape
  74. def link[T](label: String, annotations: Annotations): T
    Definition Classes
    Linkable
  75. val linkAnnotations: Option[Annotations]
    Definition Classes
    Linkable
  76. def linkCopy(): ArrayShape
    Definition Classes
    ArrayShape → 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 maxContains: Int
  82. def maxItems: IntField
    Definition Classes
    DataArrangementShape
  83. val meta: AnyShapeModel
    Definition Classes
    ArrayShape → AnyShape → AmfObject
  84. def minContains: Int
  85. def minItems: IntField
    Definition Classes
    DataArrangementShape
  86. def name: StrField
    Definition Classes
    NamedDomainElement
  87. def nameField: Field
    Attributes
    protected
    Definition Classes
    Shape → NamedDomainElement
  88. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  89. def not: Shape
    Definition Classes
    Shape
  90. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  91. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  92. def or: Seq[Shape]
    Definition Classes
    Shape
  93. def parameterValidator(mediaType: String, exec: BaseExecutionEnvironment): Option[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
  94. def parameterValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
  95. def payloadValidator(mediaType: String, exec: BaseExecutionEnvironment): Option[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
  96. def payloadValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
  97. def payloadValidator(shape: Shape, env: Environment, validationMode: ValidationMode): PlatformPayloadValidator
    Attributes
    protected
    Definition Classes
    JsonSchemaSecrets
  98. val platform: Platform
    Definition Classes
    PlatformSecrets
  99. def position(): Option[LexicalInformation]
    Definition Classes
    AmfElement
  100. def ramlSyntaxKey: String
    Definition Classes
    DataArrangementShape → AnyShape → Shape
  101. def raw: StrField
    Definition Classes
    ExternalSourceElement
  102. def readOnly: BoolField
    Definition Classes
    Shape
  103. val refAst: Option[YPart]
    Definition Classes
    Linkable
  104. val refCtx: Option[ParserContext]
    Definition Classes
    Linkable
  105. val refName: String
    Definition Classes
    Linkable
  106. def referenceId: StrField
    Definition Classes
    ExternalSourceElement
  107. def removeExamples(): Unit
    Definition Classes
    ExemplifiedDomainElement
  108. def resolveUnreferencedLink[T](label: String, annotations: Annotations, unresolved: T, supportsRecursion: Boolean): T
    Definition Classes
    Linkable
  109. def set(field: Field, value: AmfElement, annotations: Annotations): ArrayShape.this.type
    Definition Classes
    AmfObject
  110. def set(field: Field, value: AmfElement): ArrayShape.this.type
    Definition Classes
    AmfObject
  111. def set(field: Field, values: Seq[String]): ArrayShape.this.type
    Definition Classes
    AmfObject
  112. def set(field: Field, value: Float): ArrayShape.this.type
    Definition Classes
    AmfObject
  113. def set(field: Field, value: Double): ArrayShape.this.type
    Definition Classes
    AmfObject
  114. def set(field: Field, value: Int): ArrayShape.this.type
    Definition Classes
    AmfObject
  115. def set(field: Field, value: Boolean): ArrayShape.this.type
    Definition Classes
    AmfObject
  116. def set(field: Field, value: String): ArrayShape.this.type
    Definition Classes
    AmfObject
  117. def setArray(field: Field, values: Seq[AmfElement], annotations: Annotations): ArrayShape.this.type
    Definition Classes
    AmfObject
  118. def setArray(field: Field, values: Seq[AmfElement]): ArrayShape.this.type
    Definition Classes
    AmfObject
  119. def setArrayWithoutId(field: Field, values: Seq[AmfElement], annotations: Annotations): ArrayShape.this.type
    Definition Classes
    AmfObject
  120. def setArrayWithoutId(field: Field, values: Seq[AmfElement]): ArrayShape.this.type
    Definition Classes
    AmfObject
  121. def setDefaultStrValue(entry: YMapEntry): Unit
    Definition Classes
    ShapeHelper
  122. def setWithoutId(field: Field, value: AmfElement, annotations: Annotations): ArrayShape.this.type
    Definition Classes
    AmfObject
  123. val shouldLink: Boolean
    Attributes
    protected
    Definition Classes
    Linkable
  124. final def simpleAdoption(parent: String): ArrayShape.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(element: AnyShape, exec: BaseExecutionEnvironment): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  133. def toMatrixShape: MatrixShape
  134. def toMatrixShapeWithoutId: MatrixShape
  135. 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
  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: Option[String]
    Definition Classes
    ShapeHelpers
  139. def unevaluatedItems: Boolean
  140. def unevaluatedItemsSchema: Shape
  141. def uniqueItems: BoolField
    Definition Classes
    DataArrangementShape
  142. def unresolved(refName: String, refAst: YPart, unresolvedSeverity: String)(implicit ctx: ParserContext): DomainElement with Linkable
    Definition Classes
    Linkable
  143. val unresolvedSeverity: String
    Definition Classes
    Linkable
  144. def validate(fragment: PayloadFragment, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  145. def validate(fragment: PayloadFragment, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  146. def validate(fragment: PayloadFragment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  147. def validate(fragment: PayloadFragment, env: Environment, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  148. def validate(payload: String, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  149. def validate(payload: String, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  150. def validate(payload: String): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  151. def validate(payload: String, env: Environment, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  152. def validateParameter(payload: String, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  153. def validateParameter(payload: String, env: Environment = Environment(), exec: BaseExecutionEnvironment = ...): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  154. def values: Seq[DataNode]
    Definition Classes
    Shape
  155. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  156. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  157. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  158. def withAnd(subShapes: Seq[Shape]): ArrayShape.this.type
    Definition Classes
    Shape
  159. def withArrayItems(): ArrayShape
    Definition Classes
    DataArrangementShape
  160. def withCollectionFormat(collectionFormat: Boolean): ArrayShape.this.type
    Definition Classes
    DataArrangementShape
  161. def withComment(comment: String): ArrayShape.this.type
    Definition Classes
    AnyShape
  162. def withContains(contains: Shape): ArrayShape.this.type
  163. def withCustomDomainProperties(extensions: Seq[DomainExtension]): ArrayShape.this.type
    Definition Classes
    DomainElement
  164. def withCustomDomainProperty(extensions: DomainExtension): ArrayShape.this.type
    Definition Classes
    DomainElement
  165. def withCustomShapeProperties(properties: Seq[ShapeExtension]): ArrayShape.this.type
    Definition Classes
    Shape
  166. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  167. def withCustomShapePropertyDefinitions(propertyDefinitions: Seq[PropertyShape]): ArrayShape.this.type
    Definition Classes
    Shape
  168. def withDefault(default: DataNode): ArrayShape.this.type
    Definition Classes
    Shape
  169. def withDefaultStr(value: String): ArrayShape.this.type
    Definition Classes
    Shape
  170. def withDeprecated(deprecated: Boolean): ArrayShape.this.type
    Definition Classes
    Shape
  171. def withDescription(description: String): ArrayShape.this.type
    Definition Classes
    Shape
  172. def withDisplayName(name: String): ArrayShape.this.type
    Definition Classes
    Shape
  173. def withDocumentation(documentation: CreativeWork): ArrayShape.this.type
    Definition Classes
    AnyShape
  174. def withElse(elseShape: Shape): ArrayShape.this.type
    Definition Classes
    Shape
  175. def withExample(name: Option[String]): Example
    Definition Classes
    ExemplifiedDomainElement
  176. def withExamples(examples: Seq[Example]): ArrayShape.this.type
    Definition Classes
    ExemplifiedDomainElement
  177. def withExtends(extend: Seq[DomainElement]): ArrayShape.this.type
    Definition Classes
    DomainElement
  178. def withId(value: String): ArrayShape.this.type
    Definition Classes
    AmfObject
  179. def withIf(ifShape: Shape): ArrayShape.this.type
    Definition Classes
    Shape
  180. def withInherits(inherits: Seq[Shape]): ArrayShape.this.type
    Definition Classes
    Shape
  181. def withIsExternalLink(isReference: Boolean): ArrayShape.this.type
    Definition Classes
    DomainElement
  182. def withItems(items: Shape): ArrayShape.this.type
  183. def withLinkLabel(label: String): ArrayShape.this.type
    Definition Classes
    Linkable
  184. def withLinkTarget(target: DomainElement): ArrayShape.this.type
    Definition Classes
    Linkable
  185. def withMaxContains(maxTimes: Int): ArrayShape.this.type
  186. def withMaxItems(maxItems: Int): ArrayShape.this.type
    Definition Classes
    DataArrangementShape
  187. def withMinContains(minTimes: Int): ArrayShape.this.type
  188. def withMinItems(minItems: Int): ArrayShape.this.type
    Definition Classes
    DataArrangementShape
  189. def withName(name: String, a: Annotations): ArrayShape.this.type
    Definition Classes
    NamedDomainElement
  190. def withNodeItems(): NodeShape
    Definition Classes
    DataArrangementShape
  191. def withNot(shape: Shape): ArrayShape.this.type
    Definition Classes
    Shape
  192. def withOr(subShapes: Seq[Shape]): ArrayShape.this.type
    Definition Classes
    Shape
  193. def withReadOnly(readOnly: Boolean): ArrayShape.this.type
    Definition Classes
    Shape
  194. def withReference(id: String): ArrayShape.this.type
    Definition Classes
    ExternalSourceElement
  195. def withScalarItems(): ScalarShape
    Definition Classes
    DataArrangementShape
  196. def withSupportsRecursion(recursive: Boolean): ArrayShape.this.type
    Definition Classes
    Linkable
  197. def withThen(thenShape: Shape): ArrayShape.this.type
    Definition Classes
    Shape
  198. def withUnevaluatedItems(value: Boolean): ArrayShape.this.type
  199. def withUnevaluatedItemsSchema(schema: Shape): ArrayShape.this.type
  200. def withUniqueItems(uniqueItems: Boolean): ArrayShape.this.type
    Definition Classes
    DataArrangementShape
  201. def withValues(values: Seq[DataNode]): ArrayShape.this.type
    Definition Classes
    Shape
  202. def withWriteOnly(writeOnly: Boolean): ArrayShape.this.type
    Definition Classes
    Shape
  203. def withXMLSerialization(xmlSerialization: XMLSerializer): ArrayShape.this.type
    Definition Classes
    AnyShape
  204. def withXone(subShapes: Seq[Shape]): ArrayShape.this.type
    Definition Classes
    Shape
  205. def writeOnly: BoolField
    Definition Classes
    Shape
  206. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
  207. 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 ValidatorAware

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