case class UnresolvedShape(fields: Fields, annotations: Annotations, reference: String, fatherExtensionParser: Option[(Option[String]) ⇒ ShapeExtensionParser] = None, updateFatherLink: Option[(String) ⇒ Unit] = None, shouldLink: Boolean = true) extends AnyShape with UnresolvedReference with Product with Serializable

Unresolved shape: intended to be resolved after parsing (exception is thrown if shape is not resolved).

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

Instance Constructors

  1. new UnresolvedShape(fields: Fields, annotations: Annotations, reference: String, fatherExtensionParser: Option[(Option[String]) ⇒ ShapeExtensionParser] = None, updateFatherLink: Option[(String) ⇒ Unit] = None, shouldLink: Boolean = true)

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): UnresolvedShape.this.type
    Definition Classes
    AmfObject
  5. def add(other: Annotations): UnresolvedShape.this.type
    Definition Classes
    AmfElement
  6. def add(annotation: Annotation): UnresolvedShape.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]): UnresolvedShape.this.type
    Definition Classes
    AmfObject
  10. def afterResolve(fatherSyntaxKey: Option[String], resolvedKey: String): Unit
    Definition Classes
    UnresolvedShape → Linkable
  11. def and: Seq[Shape]
    Definition Classes
    Shape
  12. val annotations: Annotations
    Definition Classes
    UnresolvedShape → 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
    UnresolvedShape → 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): UnresolvedShape.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
    UnresolvedShape → 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(): UnresolvedShape.this.type
    Definition Classes
    AnyShape → Shape
  32. def copyShape(a: Annotations): UnresolvedShape.this.type
    Definition Classes
    Shape
  33. val ctx: Option[ParserContext]
    Definition Classes
    UnresolvedReference
  34. def customDomainProperties: Seq[DomainExtension]
    Definition Classes
    DomainElement
  35. def customShapeProperties: Seq[ShapeExtension]
    Definition Classes
    Shape
  36. def customShapePropertyDefinitions: Seq[PropertyShape]
    Definition Classes
    Shape
  37. def default: DataNode
    Definition Classes
    Shape
  38. def defaultString: StrField
    Definition Classes
    Shape
  39. def deprecated: BoolField
    Definition Classes
    Shape
  40. def description: StrField
    Definition Classes
    Shape
  41. def displayName: StrField
    Definition Classes
    Shape
  42. def documentation: CreativeWork
    Definition Classes
    AnyShape
  43. def effectiveInherits: Seq[Shape]
    Definition Classes
    Shape
  44. def effectiveLinkTarget(links: Seq[String] = Seq()): UnresolvedShape
    Definition Classes
    UnresolvedShape → 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 fatherExtensionParser: Option[(Option[String]) ⇒ ShapeExtensionParser]
  52. val fields: Fields
    Definition Classes
    UnresolvedShape → AnyShape → AmfObject
  53. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  54. def fromExternalSource: Boolean
    Definition Classes
    ShapeHelpers
  55. def fromLocal(): Boolean
    Definition Classes
    AmfElement
  56. def fromTypeExpression: Boolean
    Definition Classes
    ShapeHelpers
  57. def futureRef(resolve: (Linkable) ⇒ Unit): Unit
    Definition Classes
    UnresolvedReference
  58. def generateJsonSchema(element: AnyShape, options: ShapeRenderOptions = ShapeRenderOptions()): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  59. 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
  60. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  61. lazy val graph: Graph
    Definition Classes
    DomainElement
  62. val id: String
    Definition Classes
    AmfObject
  63. def ifShape: Shape
    Definition Classes
    Shape
  64. val inheritedIds: Seq[String]
    Definition Classes
    InheritanceChain
  65. def inherits: Seq[Shape]
    Definition Classes
    Shape
  66. def inlined: 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. 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 link[T](label: String, annotations: Annotations): T
    Definition Classes
    UnresolvedShape → Linkable
  74. val linkAnnotations: Option[Annotations]
    Definition Classes
    Linkable
  75. def linkCopy(): AnyShape
    Definition Classes
    UnresolvedShape → AnyShape → Linkable
  76. def linkLabel: StrField
    Definition Classes
    Linkable
  77. def linkSubType(shape: AnyShape): Unit
    Definition Classes
    InheritanceChain
  78. def linkTarget: Option[DomainElement]
    Definition Classes
    Linkable
  79. def location(): Option[String]
    Definition Classes
    ExternalSourceElement → AmfElement
  80. val meta: AnyShapeModel
    Definition Classes
    UnresolvedShape → AnyShape → AmfObject
  81. def name: StrField
    Definition Classes
    NamedDomainElement
  82. def nameField: Field
    Attributes
    protected
    Definition Classes
    Shape → NamedDomainElement
  83. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  84. def not: Shape
    Definition Classes
    Shape
  85. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  86. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  87. def or: Seq[Shape]
    Definition Classes
    Shape
  88. def parameterValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  89. def payloadValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  90. def payloadValidator(shape: Shape, env: Environment, validationMode: ValidationMode): PlatformPayloadValidator
    Attributes
    protected
    Definition Classes
    JsonSchemaSecrets
  91. def position(): Option[LexicalInformation]
    Definition Classes
    AmfElement
  92. def ramlSyntaxKey: String
    Definition Classes
    AnyShape → Shape
  93. def raw: StrField
    Definition Classes
    ExternalSourceElement
  94. def readOnly: BoolField
    Definition Classes
    Shape
  95. val refAst: Option[YPart]
    Definition Classes
    Linkable
  96. val refCtx: Option[ParserContext]
    Definition Classes
    Linkable
  97. val refName: String
    Definition Classes
    Linkable
  98. val reference: String
    Definition Classes
    UnresolvedShape → UnresolvedReference
  99. def referenceId: StrField
    Definition Classes
    ExternalSourceElement
  100. def removeExamples(): Unit
    Definition Classes
    ExemplifiedDomainElement
  101. def resolve(target: Shape): Shape

    Resolve UnresolvedShape as link to specified target.

  102. def resolveUnreferencedLink[T](label: String, annotations: Annotations, unresolved: T, supportsRecursion: Boolean): T
    Definition Classes
    Linkable
  103. def set(field: Field, value: AmfElement, annotations: Annotations): UnresolvedShape.this.type
    Definition Classes
    AmfObject
  104. def set(field: Field, value: AmfElement): UnresolvedShape.this.type
    Definition Classes
    AmfObject
  105. def set(field: Field, values: Seq[String]): UnresolvedShape.this.type
    Definition Classes
    AmfObject
  106. def set(field: Field, value: Float): UnresolvedShape.this.type
    Definition Classes
    AmfObject
  107. def set(field: Field, value: Double): UnresolvedShape.this.type
    Definition Classes
    AmfObject
  108. def set(field: Field, value: Int): UnresolvedShape.this.type
    Definition Classes
    AmfObject
  109. def set(field: Field, value: Boolean): UnresolvedShape.this.type
    Definition Classes
    AmfObject
  110. def set(field: Field, value: String): UnresolvedShape.this.type
    Definition Classes
    AmfObject
  111. def setArray(field: Field, values: Seq[AmfElement], annotations: Annotations): UnresolvedShape.this.type
    Definition Classes
    AmfObject
  112. def setArray(field: Field, values: Seq[AmfElement]): UnresolvedShape.this.type
    Definition Classes
    AmfObject
  113. def setArrayWithoutId(field: Field, values: Seq[AmfElement], annotations: Annotations): UnresolvedShape.this.type
    Definition Classes
    AmfObject
  114. def setArrayWithoutId(field: Field, values: Seq[AmfElement]): UnresolvedShape.this.type
    Definition Classes
    AmfObject
  115. def setDefaultStrValue(entry: YMapEntry): Unit
    Definition Classes
    ShapeHelper
  116. val shouldLink: Boolean
    Definition Classes
    UnresolvedShape → Linkable
  117. final def simpleAdoption(parent: String): UnresolvedShape.this.type
    Definition Classes
    AmfObject
  118. val subTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  119. val superTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  120. def supportsRecursion: BoolField
    Definition Classes
    Linkable
  121. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  122. def thenShape: Shape
    Definition Classes
    Shape
  123. def toFutureRef(resolve: (Linkable) ⇒ Unit): Unit
    Definition Classes
    Linkable
  124. def toJsonSchema: String
    Definition Classes
    AnyShape
  125. def toJsonSchema(element: AnyShape): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  126. 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
  127. 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
  128. def trackedExample(trackId: String): Option[Example]
    Definition Classes
    AnyShape
  129. def typeExpression(eh: ErrorHandler): String
    Definition Classes
    ShapeHelpers
  130. def unresolved(refName: String, refAst: YPart, unresolvedSeverity: String)(implicit ctx: ParserContext): DomainElement with Linkable
    Definition Classes
    Linkable
  131. val unresolvedSeverity: String
    Definition Classes
    Linkable
  132. val updateFatherLink: Option[(String) ⇒ Unit]
  133. def validate(fragment: PayloadFragment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  134. def validate(fragment: PayloadFragment, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  135. def validate(payload: String): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  136. def validate(payload: String, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  137. def validateParameter(payload: String): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  138. def validateParameter(payload: String, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  139. def values: Seq[DataNode]
    Definition Classes
    Shape
  140. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  141. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  142. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  143. def withAnd(subShapes: Seq[Shape]): UnresolvedShape.this.type
    Definition Classes
    Shape
  144. def withComment(comment: String): UnresolvedShape.this.type
    Definition Classes
    AnyShape
  145. def withContext(c: ParserContext): DomainElement
    Definition Classes
    UnresolvedReference
  146. def withCustomDomainProperties(extensions: Seq[DomainExtension]): UnresolvedShape.this.type
    Definition Classes
    DomainElement
  147. def withCustomDomainProperty(extensions: DomainExtension): UnresolvedShape.this.type
    Definition Classes
    DomainElement
  148. def withCustomShapeProperties(properties: Seq[ShapeExtension]): UnresolvedShape.this.type
    Definition Classes
    Shape
  149. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  150. def withCustomShapePropertyDefinitions(propertyDefinitions: Seq[PropertyShape]): UnresolvedShape.this.type
    Definition Classes
    Shape
  151. def withDefault(default: DataNode): UnresolvedShape.this.type
    Definition Classes
    Shape
  152. def withDefaultStr(value: String): UnresolvedShape.this.type
    Definition Classes
    Shape
  153. def withDeprecated(deprecated: Boolean): UnresolvedShape.this.type
    Definition Classes
    Shape
  154. def withDescription(description: String): UnresolvedShape.this.type
    Definition Classes
    Shape
  155. def withDisplayName(name: String): UnresolvedShape.this.type
    Definition Classes
    Shape
  156. def withDocumentation(documentation: CreativeWork): UnresolvedShape.this.type
    Definition Classes
    AnyShape
  157. def withElse(elseShape: Shape): UnresolvedShape.this.type
    Definition Classes
    Shape
  158. def withExample(name: Option[String]): Example
    Definition Classes
    ExemplifiedDomainElement
  159. def withExamples(examples: Seq[Example]): UnresolvedShape.this.type
    Definition Classes
    ExemplifiedDomainElement
  160. def withExtends(extend: Seq[DomainElement]): UnresolvedShape.this.type
    Definition Classes
    DomainElement
  161. def withId(value: String): UnresolvedShape.this.type
    Definition Classes
    AmfObject
  162. def withIf(ifShape: Shape): UnresolvedShape.this.type
    Definition Classes
    Shape
  163. def withInherits(inherits: Seq[Shape]): UnresolvedShape.this.type
    Definition Classes
    Shape
  164. def withLinkLabel(label: String): UnresolvedShape.this.type
    Definition Classes
    Linkable
  165. def withLinkTarget(target: DomainElement): UnresolvedShape.this.type
    Definition Classes
    Linkable
  166. def withName(name: String, a: Annotations): UnresolvedShape.this.type
    Definition Classes
    NamedDomainElement
  167. def withNot(shape: Shape): UnresolvedShape.this.type
    Definition Classes
    Shape
  168. def withOr(subShapes: Seq[Shape]): UnresolvedShape.this.type
    Definition Classes
    Shape
  169. def withReadOnly(readOnly: Boolean): UnresolvedShape.this.type
    Definition Classes
    Shape
  170. def withReference(id: String): UnresolvedShape.this.type
    Definition Classes
    ExternalSourceElement
  171. def withSupportsRecursion(recursive: Boolean): UnresolvedShape.this.type
    Definition Classes
    Linkable
  172. def withThen(thenShape: Shape): UnresolvedShape.this.type
    Definition Classes
    Shape
  173. def withValues(values: Seq[DataNode]): UnresolvedShape.this.type
    Definition Classes
    Shape
  174. def withWriteOnly(writeOnly: Boolean): UnresolvedShape.this.type
    Definition Classes
    Shape
  175. def withXMLSerialization(xmlSerialization: XMLSerializer): UnresolvedShape.this.type
    Definition Classes
    AnyShape
  176. def withXone(subShapes: Seq[Shape]): UnresolvedShape.this.type
    Definition Classes
    Shape
  177. def writeOnly: BoolField
    Definition Classes
    Shape
  178. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
  179. def xone: Seq[Shape]
    Definition Classes
    Shape

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from UnresolvedReference

Inherited from AnyShape

Inherited from ExemplifiedDomainElement

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