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

Node shape.

Linear Supertypes
Serializable, Serializable, Product, Equals, 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. NodeShape
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyShape
  7. ExemplifiedDomainElement
  8. DocumentedElement
  9. InheritanceChain
  10. ExternalSourceElement
  11. RamlDatatypeSerializer
  12. JsonSchemaSerializer
  13. PlatformSecrets
  14. ShapeHelpers
  15. JsonSchemaSecrets
  16. Shape
  17. ShapeHelper
  18. NamedDomainElement
  19. Linkable
  20. DomainElement
  21. AmfObject
  22. AmfElement
  23. AnyRef
  24. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new NodeShape(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): NodeShape.this.type
    Definition Classes
    AmfObject
  5. def add(other: Annotations): NodeShape.this.type
    Definition Classes
    AmfElement
  6. def add(annotation: Annotation): NodeShape.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 additionalPropertiesSchema: Shape
  10. def adopted(parent: String, cycle: Seq[String] = Seq()): NodeShape.this.type
    Definition Classes
    NodeShape → AmfObject
  11. def afterResolve(fatherSyntaxKey: Option[String], resolvedId: String): Unit
    Definition Classes
    Linkable
  12. def and: Seq[Shape]
    Definition Classes
    Shape
  13. val annotations: Annotations
    Definition Classes
    NodeShape → AnyShape → AmfElement
  14. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  15. def buildFixPoint(id: Option[String], name: String, link: Linkable, recursionErrorHandler: Option[ErrorHandler]): RecursiveShape
    Attributes
    protected
    Definition Classes
    ShapeHelpers
  16. def buildJsonSchema(options: ShapeRenderOptions = ShapeRenderOptions(), exec: BaseExecutionEnvironment = ...): String
    Definition Classes
    AnyShape
  17. def buildRamlDatatype(exec: BaseExecutionEnvironment = ...): 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
    NodeShape → 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): NodeShape.this.type
    Definition Classes
    ShapeHelpers
  22. def closed: BoolField
  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
    NodeShape → 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(): NodeShape.this.type
    Definition Classes
    AnyShape → Shape
  32. def copyShape(a: Annotations): NodeShape.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 dependencies: Seq[PropertyDependencies]
  39. def deprecated: BoolField
    Definition Classes
    Shape
  40. def description: StrField
    Definition Classes
    Shape
  41. def discriminator: StrField
  42. def discriminatorMapping: Seq[IriTemplateMapping]
  43. def discriminatorValue: StrField
  44. def displayName: StrField
    Definition Classes
    Shape
  45. def documentation: CreativeWork
    Definition Classes
    AnyShape
  46. def documentations: Seq[CreativeWork]
    Definition Classes
    AnyShape → DocumentedElement
  47. def effectiveInherits: Seq[Shape]
    Definition Classes
    Shape
  48. def effectiveLinkTarget(links: Seq[String]): DomainElement
    Definition Classes
    Linkable
  49. def effectiveStructuralShapes: Seq[Shape]
    Definition Classes
    InheritanceChain
  50. def elseShape: Shape
    Definition Classes
    Shape
  51. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  52. def examples: Seq[Example]
    Definition Classes
    ExemplifiedDomainElement
  53. def extend: Seq[DomainElement]
    Definition Classes
    DomainElement
  54. def externalSourceID: Option[String]
    Definition Classes
    ShapeHelpers
  55. val fields: Fields
    Definition Classes
    NodeShape → AnyShape → AmfObject
  56. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  57. def fromExternalSource: Boolean
    Definition Classes
    ShapeHelpers
  58. def fromLocal(): Boolean
    Definition Classes
    AmfElement
  59. def fromTypeExpression: Boolean
    Definition Classes
    ShapeHelpers
  60. def generateJsonSchema(element: AnyShape, options: ShapeRenderOptions = ShapeRenderOptions(), exec: BaseExecutionEnvironment): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  61. 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
  62. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  63. lazy val graph: Graph
    Definition Classes
    DomainElement
  64. val id: String
    Definition Classes
    AmfObject
  65. def ifShape: Shape
    Definition Classes
    Shape
  66. val inheritedIds: Seq[String]
    Definition Classes
    InheritanceChain
  67. def inherits: Seq[Shape]
    Definition Classes
    Shape
  68. def inlined: Boolean
    Definition Classes
    AnyShape
  69. def isAnyType: Boolean
    Definition Classes
    AnyShape
  70. 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
  71. def isExternalLink: BoolField
    Definition Classes
    DomainElement
  72. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  73. def isLink: Boolean
    Definition Classes
    Linkable
  74. def isLinkToSource: Boolean
    Definition Classes
    ExternalSourceElement
  75. def isTrackedBy(trackId: String): Boolean
    Definition Classes
    AmfElement
  76. val isUnresolved: Boolean
    Definition Classes
    Linkable
  77. def link[T](label: String, annotations: Annotations): T
    Definition Classes
    Linkable
  78. val linkAnnotations: Option[Annotations]
    Definition Classes
    Linkable
  79. def linkCopy(): NodeShape
    Definition Classes
    NodeShape → AnyShape → Linkable
  80. def linkLabel: StrField
    Definition Classes
    Linkable
  81. def linkSubType(shape: AnyShape): Unit
    Definition Classes
    InheritanceChain
  82. def linkTarget: Option[DomainElement]
    Definition Classes
    Linkable
  83. def location(): Option[String]
    Definition Classes
    ExternalSourceElement → AmfElement
  84. def maxProperties: IntField
  85. val meta: AnyShapeModel
    Definition Classes
    NodeShape → AnyShape → AmfObject
  86. def minProperties: IntField
  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 properties: Seq[PropertyShape]
  102. def propertyNames: Shape
  103. val ramlSyntaxKey: String
    Definition Classes
    NodeShape → AnyShape → Shape
  104. def raw: StrField
    Definition Classes
    ExternalSourceElement
  105. def readOnly: BoolField
    Definition Classes
    Shape
  106. val refAst: Option[YPart]
    Definition Classes
    Linkable
  107. val refCtx: Option[ParserContext]
    Definition Classes
    Linkable
  108. val refName: String
    Definition Classes
    Linkable
  109. def referenceId: StrField
    Definition Classes
    ExternalSourceElement
  110. def removeExamples(): Unit
    Definition Classes
    ExemplifiedDomainElement
  111. def resolveUnreferencedLink[T](label: String, annotations: Annotations, unresolved: T, supportsRecursion: Boolean): T
    Definition Classes
    Linkable
  112. def schemaDependencies: Seq[SchemaDependencies]
  113. def set(field: Field, value: AmfElement, annotations: Annotations): NodeShape.this.type
    Definition Classes
    AmfObject
  114. def set(field: Field, value: AmfElement): NodeShape.this.type
    Definition Classes
    AmfObject
  115. def set(field: Field, values: Seq[String]): NodeShape.this.type
    Definition Classes
    AmfObject
  116. def set(field: Field, value: Float): NodeShape.this.type
    Definition Classes
    AmfObject
  117. def set(field: Field, value: Double): NodeShape.this.type
    Definition Classes
    AmfObject
  118. def set(field: Field, value: Int): NodeShape.this.type
    Definition Classes
    AmfObject
  119. def set(field: Field, value: Boolean): NodeShape.this.type
    Definition Classes
    AmfObject
  120. def set(field: Field, value: String): NodeShape.this.type
    Definition Classes
    AmfObject
  121. def setArray(field: Field, values: Seq[AmfElement], annotations: Annotations): NodeShape.this.type
    Definition Classes
    AmfObject
  122. def setArray(field: Field, values: Seq[AmfElement]): NodeShape.this.type
    Definition Classes
    AmfObject
  123. def setArrayWithoutId(field: Field, values: Seq[AmfElement], annotations: Annotations): NodeShape.this.type
    Definition Classes
    AmfObject
  124. def setArrayWithoutId(field: Field, values: Seq[AmfElement]): NodeShape.this.type
    Definition Classes
    AmfObject
  125. def setDefaultStrValue(entry: YMapEntry): Unit
    Definition Classes
    ShapeHelper
  126. def setWithoutId(field: Field, value: AmfElement, annotations: Annotations): NodeShape.this.type
    Definition Classes
    AmfObject
  127. val shouldLink: Boolean
    Attributes
    protected
    Definition Classes
    Linkable
  128. final def simpleAdoption(parent: String): NodeShape.this.type
    Definition Classes
    AmfObject
  129. val subTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  130. val superTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  131. def supportsRecursion: BoolField
    Definition Classes
    Linkable
  132. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  133. def thenShape: Shape
    Definition Classes
    Shape
  134. def toFutureRef(resolve: (Linkable) ⇒ Unit): Unit
    Definition Classes
    Linkable
  135. def toJsonSchema(exec: BaseExecutionEnvironment = ...): String
    Definition Classes
    AnyShape
  136. def toJsonSchema(element: AnyShape, exec: BaseExecutionEnvironment): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  137. 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
  138. 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
  139. def trackedExample(trackId: String): Option[Example]
    Definition Classes
    AnyShape
  140. def typeExpression(eh: ErrorHandler): String
    Definition Classes
    ShapeHelpers
  141. def unevaluatedProperties: Boolean
  142. def unevaluatedPropertiesSchema: Shape
  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 withAdditionalPropertiesSchema(shape: Shape): NodeShape.this.type
  160. def withAnd(subShapes: Seq[Shape]): NodeShape.this.type
    Definition Classes
    Shape
  161. def withClosed(closed: Boolean): NodeShape.this.type
  162. def withComment(comment: String): NodeShape.this.type
    Definition Classes
    AnyShape
  163. def withCustomDomainProperties(extensions: Seq[DomainExtension]): NodeShape.this.type
    Definition Classes
    DomainElement
  164. def withCustomDomainProperty(extensions: DomainExtension): NodeShape.this.type
    Definition Classes
    DomainElement
  165. def withCustomShapeProperties(properties: Seq[ShapeExtension]): NodeShape.this.type
    Definition Classes
    Shape
  166. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  167. def withCustomShapePropertyDefinitions(propertyDefinitions: Seq[PropertyShape]): NodeShape.this.type
    Definition Classes
    Shape
  168. def withDefault(default: DataNode): NodeShape.this.type
    Definition Classes
    Shape
  169. def withDefaultStr(value: String): NodeShape.this.type
    Definition Classes
    Shape
  170. def withDependencies(dependencies: Seq[PropertyDependencies]): NodeShape.this.type
  171. def withDependency(): PropertyDependencies
  172. def withDeprecated(deprecated: Boolean): NodeShape.this.type
    Definition Classes
    Shape
  173. def withDescription(description: String): NodeShape.this.type
    Definition Classes
    Shape
  174. def withDiscriminator(discriminator: String): NodeShape.this.type
  175. def withDiscriminatorMapping(mappings: Seq[IriTemplateMapping]): NodeShape.this.type
  176. def withDiscriminatorValue(value: String): NodeShape.this.type
  177. def withDisplayName(name: String): NodeShape.this.type
    Definition Classes
    Shape
  178. def withDocumentation(documentation: CreativeWork): NodeShape.this.type
    Definition Classes
    AnyShape
  179. def withElse(elseShape: Shape): NodeShape.this.type
    Definition Classes
    Shape
  180. def withExample(name: Option[String]): Example
    Definition Classes
    ExemplifiedDomainElement
  181. def withExamples(examples: Seq[Example]): NodeShape.this.type
    Definition Classes
    ExemplifiedDomainElement
  182. def withExtends(extend: Seq[DomainElement]): NodeShape.this.type
    Definition Classes
    DomainElement
  183. def withId(value: String): NodeShape.this.type
    Definition Classes
    AmfObject
  184. def withIf(ifShape: Shape): NodeShape.this.type
    Definition Classes
    Shape
  185. def withInherits(inherits: Seq[Shape]): NodeShape.this.type
    Definition Classes
    Shape
  186. def withInheritsObject(name: String): NodeShape
  187. def withInheritsScalar(name: String): ScalarShape
  188. def withIsExternalLink(isReference: Boolean): NodeShape.this.type
    Definition Classes
    DomainElement
  189. def withLinkLabel(label: String): NodeShape.this.type
    Definition Classes
    Linkable
  190. def withLinkTarget(target: DomainElement): NodeShape.this.type
    Definition Classes
    Linkable
  191. def withMaxProperties(max: Int): NodeShape.this.type
  192. def withMinProperties(min: Int): NodeShape.this.type
  193. def withName(name: String, a: Annotations): NodeShape.this.type
    Definition Classes
    NamedDomainElement
  194. def withNot(shape: Shape): NodeShape.this.type
    Definition Classes
    Shape
  195. def withOr(subShapes: Seq[Shape]): NodeShape.this.type
    Definition Classes
    Shape
  196. def withProperties(properties: Seq[PropertyShape]): NodeShape.this.type
  197. def withProperty(name: String): PropertyShape
  198. def withPropertyNames(shape: Shape): NodeShape.this.type
  199. def withReadOnly(readOnly: Boolean): NodeShape.this.type
    Definition Classes
    Shape
  200. def withReference(id: String): NodeShape.this.type
    Definition Classes
    ExternalSourceElement
  201. def withSchemaDependencies(dependencies: Seq[SchemaDependencies]): NodeShape.this.type
  202. def withSupportsRecursion(recursive: Boolean): NodeShape.this.type
    Definition Classes
    Linkable
  203. def withThen(thenShape: Shape): NodeShape.this.type
    Definition Classes
    Shape
  204. def withUnevaluatedProperties(value: Boolean): NodeShape.this.type
  205. def withUnevaluatedPropertiesSchema(shape: Shape): NodeShape.this.type
  206. def withValues(values: Seq[DataNode]): NodeShape.this.type
    Definition Classes
    Shape
  207. def withWriteOnly(writeOnly: Boolean): NodeShape.this.type
    Definition Classes
    Shape
  208. def withXMLSerialization(xmlSerialization: XMLSerializer): NodeShape.this.type
    Definition Classes
    AnyShape
  209. def withXone(subShapes: Seq[Shape]): NodeShape.this.type
    Definition Classes
    Shape
  210. def writeOnly: BoolField
    Definition Classes
    Shape
  211. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
  212. def xone: Seq[Shape]
    Definition Classes
    Shape

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

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