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

Node shape.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyShape, InheritanceChain, ExternalSourceElement, RamlDatatypeSerializer, JsonSchemaSerializer, 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. InheritanceChain
  8. ExternalSourceElement
  9. RamlDatatypeSerializer
  10. JsonSchemaSerializer
  11. ShapeHelpers
  12. JsonSchemaSecrets
  13. Shape
  14. ShapeHelper
  15. NamedDomainElement
  16. Linkable
  17. DomainElement
  18. AmfObject
  19. AmfElement
  20. AnyRef
  21. 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): String
    Definition Classes
    AnyShape
  17. def buildJsonSchema(): String
    Definition Classes
    AnyShape
  18. def buildRamlDatatype(): String

    Generates a new RAML Data Type.

    Generates a new RAML Data Type.

    Definition Classes
    AnyShape
  19. 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
  20. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  21. def cloneAllExamples(cloned: Shape, s: Shape): Unit
    Definition Classes
    ShapeHelpers
  22. def cloneShape(recursionErrorHandler: Option[ErrorHandler], withRecursionBase: Option[String] = None, traversal: ModelTraversalRegistry = ModelTraversalRegistry(), cloneExamples: Boolean = false): NodeShape.this.type
    Definition Classes
    ShapeHelpers
  23. def closed: BoolField
  24. val closureShapes: Set[Shape]
    Definition Classes
    Shape
  25. def collectCustomShapePropertyDefinitions(onlyInherited: Boolean, traversed: Set[String]): Seq[FacetsMap]
    Definition Classes
    Shape
  26. 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
  27. def computeSubtypesClosure(): Seq[Shape]
    Attributes
    protected
    Definition Classes
    InheritanceChain
  28. def copyAnyShape(fields: Fields = fields, annotations: Annotations = annotations): AnyShape
    Definition Classes
    AnyShape
  29. def copyElement(a: Annotations): Linkable with DomainElement
    Definition Classes
    Linkable
  30. def copyElement(): Linkable with DomainElement
    Definition Classes
    Linkable
  31. def copyFields(recursionErrorHandler: Option[ErrorHandler], cloned: Shape, recursionBase: Option[String], traversal: ModelTraversalRegistry): Unit
    Attributes
    protected
    Definition Classes
    Shape
  32. def copyShape(): NodeShape.this.type
    Definition Classes
    AnyShape → Shape
  33. def copyShape(a: Annotations): NodeShape.this.type
    Definition Classes
    Shape
  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 dependencies: Seq[PropertyDependencies]
  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 effectiveInherits: Seq[Shape]
    Definition Classes
    Shape
  47. def effectiveLinkTarget(links: Seq[String]): DomainElement
    Definition Classes
    Linkable
  48. def effectiveStructuralShapes: Seq[Shape]
    Definition Classes
    InheritanceChain
  49. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  50. def examples: Seq[Example]
    Definition Classes
    AnyShape
  51. def extend: Seq[DomainElement]
    Definition Classes
    DomainElement
  52. def externalSourceID: Option[String]
    Definition Classes
    ShapeHelpers
  53. val fields: Fields
    Definition Classes
    NodeShape → AnyShape → AmfObject
  54. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  55. def fromExternalSource: Boolean
    Definition Classes
    ShapeHelpers
  56. def fromLocal(): Boolean
    Definition Classes
    AmfElement
  57. def fromTypeExpression: Boolean
    Definition Classes
    ShapeHelpers
  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. val inheritedIds: Seq[String]
    Definition Classes
    InheritanceChain
  64. def inherits: Seq[Shape]
    Definition Classes
    Shape
  65. def inlined: 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. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  68. def isLink: Boolean
    Definition Classes
    Linkable
  69. def isLinkToSource: Boolean
    Definition Classes
    ExternalSourceElement
  70. def isTrackedBy(trackId: String): Boolean
    Definition Classes
    AmfElement
  71. val isUnresolved: Boolean
    Definition Classes
    Linkable
  72. def link[T](label: String, annotations: Annotations): T
    Definition Classes
    Linkable
  73. val linkAnnotations: Option[Annotations]
    Definition Classes
    Linkable
  74. def linkCopy(): NodeShape
    Definition Classes
    NodeShape → AnyShape → Linkable
  75. def linkLabel: StrField
    Definition Classes
    Linkable
  76. def linkSubType(shape: AnyShape): Unit
    Definition Classes
    InheritanceChain
  77. def linkTarget: Option[DomainElement]
    Definition Classes
    Linkable
  78. def location(): Option[String]
    Definition Classes
    ExternalSourceElement → AmfElement
  79. def maxProperties: IntField
  80. val meta: AnyShapeModel
    Definition Classes
    NodeShape → AnyShape → AmfObject
  81. def minProperties: IntField
  82. def name: StrField
    Definition Classes
    NamedDomainElement
  83. def nameField: Field
    Attributes
    protected
    Definition Classes
    Shape → NamedDomainElement
  84. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  85. def not: Shape
    Definition Classes
    Shape
  86. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  87. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  88. def or: Seq[Shape]
    Definition Classes
    Shape
  89. def parameterValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  90. def payloadValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  91. def payloadValidator(shape: Shape, validationMode: ValidationMode): PlatformPayloadValidator
    Attributes
    protected
    Definition Classes
    JsonSchemaSecrets
  92. def position(): Option[LexicalInformation]
    Definition Classes
    AmfElement
  93. def properties: Seq[PropertyShape]
  94. val ramlSyntaxKey: String
    Definition Classes
    NodeShape → AnyShape → Shape
  95. def raw: StrField
    Definition Classes
    ExternalSourceElement
  96. val refAst: Option[YPart]
    Definition Classes
    Linkable
  97. val refCtx: Option[ParserContext]
    Definition Classes
    Linkable
  98. val refName: String
    Definition Classes
    Linkable
  99. def referenceId: StrField
    Definition Classes
    ExternalSourceElement
  100. def resolveUnreferencedLink[T](label: String, annotations: Annotations, unresolved: T, supportsRecursion: Boolean): T
    Definition Classes
    Linkable
  101. def set(field: Field, value: AmfElement, annotations: Annotations): NodeShape.this.type
    Definition Classes
    AmfObject
  102. def set(field: Field, value: AmfElement): NodeShape.this.type
    Definition Classes
    AmfObject
  103. def set(field: Field, values: Seq[String]): NodeShape.this.type
    Definition Classes
    AmfObject
  104. def set(field: Field, value: Float): NodeShape.this.type
    Definition Classes
    AmfObject
  105. def set(field: Field, value: Double): NodeShape.this.type
    Definition Classes
    AmfObject
  106. def set(field: Field, value: Int): NodeShape.this.type
    Definition Classes
    AmfObject
  107. def set(field: Field, value: Boolean): NodeShape.this.type
    Definition Classes
    AmfObject
  108. def set(field: Field, value: String): NodeShape.this.type
    Definition Classes
    AmfObject
  109. def setArray(field: Field, values: Seq[AmfElement], annotations: Annotations): NodeShape.this.type
    Definition Classes
    AmfObject
  110. def setArray(field: Field, values: Seq[AmfElement]): NodeShape.this.type
    Definition Classes
    AmfObject
  111. def setArrayWithoutId(field: Field, values: Seq[AmfElement], annotations: Annotations): NodeShape.this.type
    Definition Classes
    AmfObject
  112. def setArrayWithoutId(field: Field, values: Seq[AmfElement]): NodeShape.this.type
    Definition Classes
    AmfObject
  113. def setDefaultStrValue(entry: YMapEntry): Unit
    Definition Classes
    ShapeHelper
  114. val shouldLink: Boolean
    Attributes
    protected
    Definition Classes
    Linkable
  115. final def simpleAdoption(parent: String): NodeShape.this.type
    Definition Classes
    AmfObject
  116. val subTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  117. val superTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  118. def supportsRecursion: BoolField
    Definition Classes
    Linkable
  119. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  120. def toFutureRef(resolve: (Linkable) ⇒ Unit): Unit
    Definition Classes
    Linkable
  121. def toJsonSchema: String
    Definition Classes
    AnyShape
  122. def toJsonSchema(element: AnyShape): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  123. 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
  124. 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
  125. def trackedExample(trackId: String): Option[Example]
    Definition Classes
    AnyShape
  126. def typeExpression(eh: ErrorHandler): String
    Definition Classes
    ShapeHelpers
  127. def unresolved(refName: String, refAst: YPart, unresolvedSeverity: String)(implicit ctx: ParserContext): DomainElement with Linkable
    Definition Classes
    Linkable
  128. val unresolvedSeverity: String
    Definition Classes
    Linkable
  129. def validate(fragment: PayloadFragment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  130. def validate(fragment: PayloadFragment, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  131. def validate(payload: String): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  132. def validate(payload: String, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  133. def validateParameter(payload: String): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  134. def validateParameter(payload: String, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  135. def values: Seq[DataNode]
    Definition Classes
    Shape
  136. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  137. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  138. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  139. def withAnd(subShapes: Seq[Shape]): NodeShape.this.type
    Definition Classes
    Shape
  140. def withClosed(closed: Boolean): NodeShape.this.type
  141. def withCustomDomainProperties(extensions: Seq[DomainExtension]): NodeShape.this.type
    Definition Classes
    DomainElement
  142. def withCustomDomainProperty(extensions: DomainExtension): NodeShape.this.type
    Definition Classes
    DomainElement
  143. def withCustomShapeProperties(properties: Seq[ShapeExtension]): NodeShape.this.type
    Definition Classes
    Shape
  144. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  145. def withCustomShapePropertyDefinitions(propertyDefinitions: Seq[PropertyShape]): NodeShape.this.type
    Definition Classes
    Shape
  146. def withDefault(default: DataNode): NodeShape.this.type
    Definition Classes
    Shape
  147. def withDefaultStr(value: String): NodeShape.this.type
    Definition Classes
    Shape
  148. def withDependencies(dependencies: Seq[PropertyDependencies]): NodeShape.this.type
  149. def withDependency(): PropertyDependencies
  150. def withDescription(description: String): NodeShape.this.type
    Definition Classes
    Shape
  151. def withDiscriminator(discriminator: String): NodeShape.this.type
  152. def withDiscriminatorMapping(mappings: Seq[IriTemplateMapping]): NodeShape.this.type
  153. def withDiscriminatorValue(value: String): NodeShape.this.type
  154. def withDisplayName(name: String): NodeShape.this.type
    Definition Classes
    Shape
  155. def withDocumentation(documentation: CreativeWork): NodeShape.this.type
    Definition Classes
    AnyShape
  156. def withExample(name: Option[String]): Example
    Definition Classes
    AnyShape
  157. def withExamples(examples: Seq[Example]): NodeShape.this.type
    Definition Classes
    AnyShape
  158. def withExtends(extend: Seq[DomainElement]): NodeShape.this.type
    Definition Classes
    DomainElement
  159. def withId(value: String): NodeShape.this.type
    Definition Classes
    AmfObject
  160. def withInherits(inherits: Seq[Shape]): NodeShape.this.type
    Definition Classes
    Shape
  161. def withInheritsObject(name: String): NodeShape
  162. def withInheritsScalar(name: String): ScalarShape
  163. def withLinkLabel(label: String): NodeShape.this.type
    Definition Classes
    Linkable
  164. def withLinkTarget(target: DomainElement): NodeShape.this.type
    Definition Classes
    Linkable
  165. def withMaxProperties(max: Int): NodeShape.this.type
  166. def withMinProperties(min: Int): NodeShape.this.type
  167. def withName(name: String, a: Annotations): NodeShape.this.type
    Definition Classes
    NamedDomainElement
  168. def withNot(shape: Shape): NodeShape.this.type
    Definition Classes
    Shape
  169. def withOr(subShapes: Seq[Shape]): NodeShape.this.type
    Definition Classes
    Shape
  170. def withProperties(properties: Seq[PropertyShape]): NodeShape.this.type
  171. def withProperty(name: String): PropertyShape
  172. def withReference(id: String): NodeShape.this.type
    Definition Classes
    ExternalSourceElement
  173. def withSupportsRecursion(recursive: Boolean): NodeShape.this.type
    Definition Classes
    Linkable
  174. def withValues(values: Seq[DataNode]): NodeShape.this.type
    Definition Classes
    Shape
  175. def withXMLSerialization(xmlSerialization: XMLSerializer): NodeShape.this.type
    Definition Classes
    AnyShape
  176. def withXone(subShapes: Seq[Shape]): NodeShape.this.type
    Definition Classes
    Shape
  177. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
  178. def xone: Seq[Shape]
    Definition Classes
    Shape

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

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