case class FileShape(fields: Fields, annotations: Annotations) extends AnyShape with CommonShapeFields with Product with Serializable

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

Instance Constructors

  1. new FileShape(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): FileShape.this.type
    Definition Classes
    AmfObject
  5. def add(other: Annotations): FileShape.this.type
    Definition Classes
    AmfElement
  6. def add(annotation: Annotation): FileShape.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]): FileShape.this.type
    Definition Classes
    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
    FileShape → 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): String
    Definition Classes
    AnyShape
  16. def buildJsonSchema(): String
    Definition Classes
    AnyShape
  17. def buildRamlDatatype(): 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
    FileShape → 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): FileShape.this.type
    Definition Classes
    ShapeHelpers
  22. val closureShapes: Set[Shape]
    Definition Classes
    Shape
  23. def collectCustomShapePropertyDefinitions(onlyInherited: Boolean, traversed: Set[String]): Seq[FacetsMap]
    Definition Classes
    Shape
  24. def comment: StrField
    Definition Classes
    AnyShape
  25. 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
    FileShape → AnyShape → AmfObject
  26. def computeSubtypesClosure(): Seq[Shape]
    Attributes
    protected
    Definition Classes
    InheritanceChain
  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(): FileShape.this.type
    Definition Classes
    AnyShape → Shape
  32. def copyShape(a: Annotations): FileShape.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 effectiveInherits: Seq[Shape]
    Definition Classes
    Shape
  43. def effectiveLinkTarget(links: Seq[String]): DomainElement
    Definition Classes
    Linkable
  44. def effectiveStructuralShapes: Seq[Shape]
    Definition Classes
    InheritanceChain
  45. def elseShape: Shape
    Definition Classes
    Shape
  46. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  47. def examples: Seq[Example]
    Definition Classes
    AnyShape
  48. def exclusiveMaximum: BoolField
    Definition Classes
    CommonShapeFields
  49. def exclusiveMinimum: BoolField
    Definition Classes
    CommonShapeFields
  50. def extend: Seq[DomainElement]
    Definition Classes
    DomainElement
  51. def externalSourceID: Option[String]
    Definition Classes
    ShapeHelpers
  52. val fields: Fields
    Definition Classes
    FileShape → AnyShape → AmfObject
  53. def fileTypes: Seq[StrField]
  54. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  55. def format: StrField
    Definition Classes
    CommonShapeFields
  56. def fromExternalSource: Boolean
    Definition Classes
    ShapeHelpers
  57. def fromLocal(): Boolean
    Definition Classes
    AmfElement
  58. def fromTypeExpression: Boolean
    Definition Classes
    ShapeHelpers
  59. def generateJsonSchema(element: AnyShape, options: ShapeRenderOptions = ShapeRenderOptions()): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  60. def generateRamlDatatype(element: AnyShape): String

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

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

    Attributes
    protected
    Definition Classes
    RamlDatatypeSerializer
  61. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  62. lazy val graph: Graph
    Definition Classes
    DomainElement
  63. val id: String
    Definition Classes
    AmfObject
  64. def ifShape: Shape
    Definition Classes
    Shape
  65. val inheritedIds: Seq[String]
    Definition Classes
    InheritanceChain
  66. def inherits: Seq[Shape]
    Definition Classes
    Shape
  67. def inlined: Boolean
    Definition Classes
    AnyShape
  68. 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
  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 link[T](label: String, annotations: Annotations): T
    Definition Classes
    Linkable
  75. val linkAnnotations: Option[Annotations]
    Definition Classes
    Linkable
  76. def linkCopy(): FileShape
    Definition Classes
    FileShape → 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 maxLength: IntField
    Definition Classes
    CommonShapeFields
  82. def maximum: DoubleField
    Definition Classes
    CommonShapeFields
  83. val meta: AnyShapeModel
    Definition Classes
    FileShape → AnyShape → AmfObject
  84. def minLength: IntField
    Definition Classes
    CommonShapeFields
  85. def minimum: DoubleField
    Definition Classes
    CommonShapeFields
  86. def multipleOf: DoubleField
    Definition Classes
    CommonShapeFields
  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, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  95. def pattern: StrField
    Definition Classes
    CommonShapeFields
  96. def payloadValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  97. def payloadValidator(shape: Shape, validationMode: ValidationMode): PlatformPayloadValidator
    Attributes
    protected
    Definition Classes
    JsonSchemaSecrets
  98. def position(): Option[LexicalInformation]
    Definition Classes
    AmfElement
  99. val ramlSyntaxKey: String
    Definition Classes
    FileShape → 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 resolveUnreferencedLink[T](label: String, annotations: Annotations, unresolved: T, supportsRecursion: Boolean): T
    Definition Classes
    Linkable
  107. def set(field: Field, value: AmfElement, annotations: Annotations): FileShape.this.type
    Definition Classes
    AmfObject
  108. def set(field: Field, value: AmfElement): FileShape.this.type
    Definition Classes
    AmfObject
  109. def set(field: Field, values: Seq[String]): FileShape.this.type
    Definition Classes
    AmfObject
  110. def set(field: Field, value: Float): FileShape.this.type
    Definition Classes
    AmfObject
  111. def set(field: Field, value: Double): FileShape.this.type
    Definition Classes
    AmfObject
  112. def set(field: Field, value: Int): FileShape.this.type
    Definition Classes
    AmfObject
  113. def set(field: Field, value: Boolean): FileShape.this.type
    Definition Classes
    AmfObject
  114. def set(field: Field, value: String): FileShape.this.type
    Definition Classes
    AmfObject
  115. def setArray(field: Field, values: Seq[AmfElement], annotations: Annotations): FileShape.this.type
    Definition Classes
    AmfObject
  116. def setArray(field: Field, values: Seq[AmfElement]): FileShape.this.type
    Definition Classes
    AmfObject
  117. def setArrayWithoutId(field: Field, values: Seq[AmfElement], annotations: Annotations): FileShape.this.type
    Definition Classes
    AmfObject
  118. def setArrayWithoutId(field: Field, values: Seq[AmfElement]): FileShape.this.type
    Definition Classes
    AmfObject
  119. def setDefaultStrValue(entry: YMapEntry): Unit
    Definition Classes
    ShapeHelper
  120. val shouldLink: Boolean
    Attributes
    protected
    Definition Classes
    Linkable
  121. final def simpleAdoption(parent: String): FileShape.this.type
    Definition Classes
    AmfObject
  122. val subTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  123. val superTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  124. def supportsRecursion: BoolField
    Definition Classes
    Linkable
  125. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  126. def thenShape: Shape
    Definition Classes
    Shape
  127. def toFutureRef(resolve: (Linkable) ⇒ Unit): Unit
    Definition Classes
    Linkable
  128. def toJsonSchema: String
    Definition Classes
    AnyShape
  129. def toJsonSchema(element: AnyShape): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  130. 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
  131. def toRamlDatatype(element: AnyShape): String

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from CommonShapeFields

Inherited from AnyShape

Inherited from InheritanceChain

Inherited from ExternalSourceElement

Inherited from RamlDatatypeSerializer

Inherited from JsonSchemaSerializer

Inherited from ShapeHelpers

Inherited from JsonSchemaSecrets

Inherited from Shape

Inherited from ShapeHelper

Inherited from NamedDomainElement

Inherited from Linkable

Inherited from DomainElement

Inherited from AmfObject

Inherited from AmfElement

Inherited from AnyRef

Inherited from Any

Ungrouped