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

Linear Supertypes
Serializable, Serializable, Product, Equals, CommonShapeFields, 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. FileShape
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. CommonShapeFields
  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 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 = 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
    FileShape → 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): FileShape.this.type
    Definition Classes
    ShapeHelpers
  21. def collectCustomShapePropertyDefinitions(onlyInherited: Boolean, traversed: Set[String]): Seq[FacetsMap]
    Definition Classes
    Shape
  22. def comment: StrField
    Definition Classes
    AnyShape
  23. 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
  24. def computeSubtypesClosure(): Seq[Shape]
    Attributes
    protected
    Definition Classes
    InheritanceChain
  25. def copyAnyShape(fields: Fields = fields, annotations: Annotations = annotations): AnyShape
    Definition Classes
    AnyShape
  26. def copyElement(a: Annotations): Linkable with DomainElement
    Definition Classes
    Linkable
  27. def copyElement(): Linkable with DomainElement
    Definition Classes
    Linkable
  28. def copyFields(recursionErrorHandler: Option[ErrorHandler], cloned: Shape, recursionBase: Option[String], traversal: ModelTraversalRegistry): Unit
    Attributes
    protected
    Definition Classes
    Shape
  29. def copyShape(): FileShape.this.type
    Definition Classes
    AnyShape → Shape
  30. def copyShape(a: Annotations): FileShape.this.type
    Definition Classes
    Shape
  31. def customDomainProperties: Seq[DomainExtension]
    Definition Classes
    DomainElement
  32. def customShapeProperties: Seq[ShapeExtension]
    Definition Classes
    Shape
  33. def customShapePropertyDefinitions: Seq[PropertyShape]
    Definition Classes
    Shape
  34. def default: DataNode
    Definition Classes
    Shape
  35. def defaultString: StrField
    Definition Classes
    Shape
  36. def deprecated: BoolField
    Definition Classes
    Shape
  37. def description: StrField
    Definition Classes
    Shape
  38. def displayName: StrField
    Definition Classes
    Shape
  39. def documentation: CreativeWork
    Definition Classes
    AnyShape
  40. def documentations: Seq[CreativeWork]
    Definition Classes
    AnyShape → DocumentedElement
  41. def effectiveInherits: Seq[Shape]
    Definition Classes
    Shape
  42. def effectiveLinkTarget(links: Seq[String]): DomainElement
    Definition Classes
    Linkable
  43. def effectiveStructuralShapes: Seq[Shape]
    Definition Classes
    InheritanceChain
  44. def elseShape: Shape
    Definition Classes
    Shape
  45. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  46. def examples: Seq[Example]
    Definition Classes
    ExemplifiedDomainElement
  47. def exclusiveMaximum: BoolField
    Definition Classes
    CommonShapeFields
  48. def exclusiveMinimum: BoolField
    Definition Classes
    CommonShapeFields
  49. def extend: Seq[DomainElement]
    Definition Classes
    DomainElement
  50. def externalSourceID: Option[String]
    Definition Classes
    ShapeHelpers
  51. val fields: Fields
    Definition Classes
    FileShape → AnyShape → AmfObject
  52. def fileTypes: Seq[StrField]
  53. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  54. def format: StrField
    Definition Classes
    CommonShapeFields
  55. def fromExternalSource: Boolean
    Definition Classes
    ShapeHelpers
  56. def fromLocal(): Boolean
    Definition Classes
    AmfElement
  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 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, exec: BaseExecutionEnvironment): Option[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
  95. def parameterValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
  96. def pattern: StrField
    Definition Classes
    CommonShapeFields
  97. def payloadValidator(mediaType: String, exec: BaseExecutionEnvironment): Option[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
  98. def payloadValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
  99. def payloadValidator(shape: Shape, env: Environment, validationMode: ValidationMode): PlatformPayloadValidator
    Attributes
    protected
    Definition Classes
    JsonSchemaSecrets
  100. val platform: Platform
    Definition Classes
    PlatformSecrets
  101. def position(): Option[LexicalInformation]
    Definition Classes
    AmfElement
  102. val ramlSyntaxKey: String
    Definition Classes
    FileShape → AnyShape → Shape
  103. def raw: StrField
    Definition Classes
    ExternalSourceElement
  104. def readOnly: BoolField
    Definition Classes
    Shape
  105. val refAst: Option[YPart]
    Definition Classes
    Linkable
  106. val refCtx: Option[ParserContext]
    Definition Classes
    Linkable
  107. val refName: String
    Definition Classes
    Linkable
  108. def referenceId: StrField
    Definition Classes
    ExternalSourceElement
  109. def removeExamples(): Unit
    Definition Classes
    ExemplifiedDomainElement
  110. def resolveUnreferencedLink[T](label: String, annotations: Annotations, unresolved: T, supportsRecursion: Boolean): T
    Definition Classes
    Linkable
  111. def set(field: Field, value: AmfElement, annotations: Annotations): FileShape.this.type
    Definition Classes
    AmfObject
  112. def set(field: Field, value: AmfElement): FileShape.this.type
    Definition Classes
    AmfObject
  113. def set(field: Field, values: Seq[String]): FileShape.this.type
    Definition Classes
    AmfObject
  114. def set(field: Field, value: Float): FileShape.this.type
    Definition Classes
    AmfObject
  115. def set(field: Field, value: Double): FileShape.this.type
    Definition Classes
    AmfObject
  116. def set(field: Field, value: Int): FileShape.this.type
    Definition Classes
    AmfObject
  117. def set(field: Field, value: Boolean): FileShape.this.type
    Definition Classes
    AmfObject
  118. def set(field: Field, value: String): FileShape.this.type
    Definition Classes
    AmfObject
  119. def setArray(field: Field, values: Seq[AmfElement], annotations: Annotations): FileShape.this.type
    Definition Classes
    AmfObject
  120. def setArray(field: Field, values: Seq[AmfElement]): FileShape.this.type
    Definition Classes
    AmfObject
  121. def setArrayWithoutId(field: Field, values: Seq[AmfElement], annotations: Annotations): FileShape.this.type
    Definition Classes
    AmfObject
  122. def setArrayWithoutId(field: Field, values: Seq[AmfElement]): FileShape.this.type
    Definition Classes
    AmfObject
  123. def setDefaultStrValue(entry: YMapEntry): Unit
    Definition Classes
    ShapeHelper
  124. def setWithoutId(field: Field, value: AmfElement, annotations: Annotations): FileShape.this.type
    Definition Classes
    AmfObject
  125. val shouldLink: Boolean
    Attributes
    protected
    Definition Classes
    Linkable
  126. final def simpleAdoption(parent: String): FileShape.this.type
    Definition Classes
    AmfObject
  127. val subTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  128. val superTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  129. def supportsRecursion: BoolField
    Definition Classes
    Linkable
  130. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  131. def thenShape: Shape
    Definition Classes
    Shape
  132. def toFutureRef(resolve: (Linkable) ⇒ Unit): Unit
    Definition Classes
    Linkable
  133. def toJsonSchema(exec: BaseExecutionEnvironment = ...): String
    Definition Classes
    AnyShape
  134. def toJsonSchema(element: AnyShape, exec: BaseExecutionEnvironment): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  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 unresolved(refName: String, refAst: YPart, unresolvedSeverity: String)(implicit ctx: ParserContext): DomainElement with Linkable
    Definition Classes
    Linkable
  140. val unresolvedSeverity: String
    Definition Classes
    Linkable
  141. def validate(fragment: PayloadFragment, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  142. def validate(fragment: PayloadFragment, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  143. def validate(fragment: PayloadFragment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  144. def validate(fragment: PayloadFragment, env: Environment, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  145. def validate(payload: String, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  146. def validate(payload: String, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  147. def validate(payload: String): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  148. def validate(payload: String, env: Environment, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  149. def validateParameter(payload: String, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  150. def validateParameter(payload: String, env: Environment = Environment(), exec: BaseExecutionEnvironment = ...): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  151. def values: Seq[DataNode]
    Definition Classes
    Shape
  152. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  153. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  154. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  155. def withAnd(subShapes: Seq[Shape]): FileShape.this.type
    Definition Classes
    Shape
  156. def withComment(comment: String): FileShape.this.type
    Definition Classes
    AnyShape
  157. def withCustomDomainProperties(extensions: Seq[DomainExtension]): FileShape.this.type
    Definition Classes
    DomainElement
  158. def withCustomDomainProperty(extensions: DomainExtension): FileShape.this.type
    Definition Classes
    DomainElement
  159. def withCustomShapeProperties(properties: Seq[ShapeExtension]): FileShape.this.type
    Definition Classes
    Shape
  160. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  161. def withCustomShapePropertyDefinitions(propertyDefinitions: Seq[PropertyShape]): FileShape.this.type
    Definition Classes
    Shape
  162. def withDefault(default: DataNode): FileShape.this.type
    Definition Classes
    Shape
  163. def withDefaultStr(value: String): FileShape.this.type
    Definition Classes
    Shape
  164. def withDeprecated(deprecated: Boolean): FileShape.this.type
    Definition Classes
    Shape
  165. def withDescription(description: String): FileShape.this.type
    Definition Classes
    Shape
  166. def withDisplayName(name: String): FileShape.this.type
    Definition Classes
    Shape
  167. def withDocumentation(documentation: CreativeWork): FileShape.this.type
    Definition Classes
    AnyShape
  168. def withElse(elseShape: Shape): FileShape.this.type
    Definition Classes
    Shape
  169. def withExample(name: Option[String]): Example
    Definition Classes
    ExemplifiedDomainElement
  170. def withExamples(examples: Seq[Example]): FileShape.this.type
    Definition Classes
    ExemplifiedDomainElement
  171. def withExclusiveMaximum(max: Boolean): FileShape.this.type
    Definition Classes
    CommonShapeFields
  172. def withExclusiveMinimum(min: Boolean): FileShape.this.type
    Definition Classes
    CommonShapeFields
  173. def withExtends(extend: Seq[DomainElement]): FileShape.this.type
    Definition Classes
    DomainElement
  174. def withFileTypes(fileTypes: Seq[String]): FileShape.this.type
  175. def withFormat(format: String): FileShape.this.type
    Definition Classes
    CommonShapeFields
  176. def withId(value: String): FileShape.this.type
    Definition Classes
    AmfObject
  177. def withIf(ifShape: Shape): FileShape.this.type
    Definition Classes
    Shape
  178. def withInherits(inherits: Seq[Shape]): FileShape.this.type
    Definition Classes
    Shape
  179. def withIsExternalLink(isReference: Boolean): FileShape.this.type
    Definition Classes
    DomainElement
  180. def withLinkLabel(label: String): FileShape.this.type
    Definition Classes
    Linkable
  181. def withLinkTarget(target: DomainElement): FileShape.this.type
    Definition Classes
    Linkable
  182. def withMaxLength(max: Int): FileShape.this.type
    Definition Classes
    CommonShapeFields
  183. def withMaximum(max: Double): FileShape.this.type
    Definition Classes
    CommonShapeFields
  184. def withMinLength(min: Int): FileShape.this.type
    Definition Classes
    CommonShapeFields
  185. def withMinimum(min: Double): FileShape.this.type
    Definition Classes
    CommonShapeFields
  186. def withMultipleOf(multiple: Double): FileShape.this.type
    Definition Classes
    CommonShapeFields
  187. def withName(name: String, a: Annotations): FileShape.this.type
    Definition Classes
    NamedDomainElement
  188. def withNot(shape: Shape): FileShape.this.type
    Definition Classes
    Shape
  189. def withOr(subShapes: Seq[Shape]): FileShape.this.type
    Definition Classes
    Shape
  190. def withPattern(pattern: String): FileShape.this.type
    Definition Classes
    CommonShapeFields
  191. def withReadOnly(readOnly: Boolean): FileShape.this.type
    Definition Classes
    Shape
  192. def withReference(id: String): FileShape.this.type
    Definition Classes
    ExternalSourceElement
  193. def withSupportsRecursion(recursive: Boolean): FileShape.this.type
    Definition Classes
    Linkable
  194. def withThen(thenShape: Shape): FileShape.this.type
    Definition Classes
    Shape
  195. def withValues(values: Seq[DataNode]): FileShape.this.type
    Definition Classes
    Shape
  196. def withWriteOnly(writeOnly: Boolean): FileShape.this.type
    Definition Classes
    Shape
  197. def withXMLSerialization(xmlSerialization: XMLSerializer): FileShape.this.type
    Definition Classes
    AnyShape
  198. def withXone(subShapes: Seq[Shape]): FileShape.this.type
    Definition Classes
    Shape
  199. def writeOnly: BoolField
    Definition Classes
    Shape
  200. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
  201. 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 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