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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  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 comment: StrField
    Definition Classes
    AnyShape
  27. 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
  28. def computeSubtypesClosure(): Seq[Shape]
    Attributes
    protected
    Definition Classes
    InheritanceChain
  29. def copyAnyShape(fields: Fields = fields, annotations: Annotations = annotations): AnyShape
    Definition Classes
    AnyShape
  30. def copyElement(a: Annotations): Linkable with DomainElement
    Definition Classes
    Linkable
  31. def copyElement(): Linkable with DomainElement
    Definition Classes
    Linkable
  32. def copyFields(recursionErrorHandler: Option[ErrorHandler], cloned: Shape, recursionBase: Option[String], traversal: ModelTraversalRegistry): Unit
    Attributes
    protected
    Definition Classes
    Shape
  33. def copyShape(): NodeShape.this.type
    Definition Classes
    AnyShape → Shape
  34. def copyShape(a: Annotations): NodeShape.this.type
    Definition Classes
    Shape
  35. def customDomainProperties: Seq[DomainExtension]
    Definition Classes
    DomainElement
  36. def customShapeProperties: Seq[ShapeExtension]
    Definition Classes
    Shape
  37. def customShapePropertyDefinitions: Seq[PropertyShape]
    Definition Classes
    Shape
  38. def default: DataNode
    Definition Classes
    Shape
  39. def defaultString: StrField
    Definition Classes
    Shape
  40. def dependencies: Seq[PropertyDependencies]
  41. def deprecated: BoolField
    Definition Classes
    Shape
  42. def description: StrField
    Definition Classes
    Shape
  43. def discriminator: StrField
  44. def discriminatorMapping: Seq[IriTemplateMapping]
  45. def discriminatorValue: StrField
  46. def displayName: StrField
    Definition Classes
    Shape
  47. def documentation: CreativeWork
    Definition Classes
    AnyShape
  48. def effectiveInherits: Seq[Shape]
    Definition Classes
    Shape
  49. def effectiveLinkTarget(links: Seq[String]): DomainElement
    Definition Classes
    Linkable
  50. def effectiveStructuralShapes: Seq[Shape]
    Definition Classes
    InheritanceChain
  51. def elseShape: Shape
    Definition Classes
    Shape
  52. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  53. def examples: Seq[Example]
    Definition Classes
    AnyShape
  54. def extend: Seq[DomainElement]
    Definition Classes
    DomainElement
  55. def externalSourceID: Option[String]
    Definition Classes
    ShapeHelpers
  56. val fields: Fields
    Definition Classes
    NodeShape → AnyShape → AmfObject
  57. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  58. def fromExternalSource: Boolean
    Definition Classes
    ShapeHelpers
  59. def fromLocal(): Boolean
    Definition Classes
    AmfElement
  60. def fromTypeExpression: Boolean
    Definition Classes
    ShapeHelpers
  61. def generateJsonSchema(element: AnyShape, options: ShapeRenderOptions = ShapeRenderOptions()): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  62. 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
  63. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  64. lazy val graph: Graph
    Definition Classes
    DomainElement
  65. val id: String
    Definition Classes
    AmfObject
  66. def ifShape: Shape
    Definition Classes
    Shape
  67. val inheritedIds: Seq[String]
    Definition Classes
    InheritanceChain
  68. def inherits: Seq[Shape]
    Definition Classes
    Shape
  69. def inlined: 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. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  72. def isLink: Boolean
    Definition Classes
    Linkable
  73. def isLinkToSource: Boolean
    Definition Classes
    ExternalSourceElement
  74. def isTrackedBy(trackId: String): Boolean
    Definition Classes
    AmfElement
  75. val isUnresolved: Boolean
    Definition Classes
    Linkable
  76. def link[T](label: String, annotations: Annotations): T
    Definition Classes
    Linkable
  77. val linkAnnotations: Option[Annotations]
    Definition Classes
    Linkable
  78. def linkCopy(): NodeShape
    Definition Classes
    NodeShape → AnyShape → Linkable
  79. def linkLabel: StrField
    Definition Classes
    Linkable
  80. def linkSubType(shape: AnyShape): Unit
    Definition Classes
    InheritanceChain
  81. def linkTarget: Option[DomainElement]
    Definition Classes
    Linkable
  82. def location(): Option[String]
    Definition Classes
    ExternalSourceElement → AmfElement
  83. def maxProperties: IntField
  84. val meta: AnyShapeModel
    Definition Classes
    NodeShape → AnyShape → AmfObject
  85. def minProperties: IntField
  86. def name: StrField
    Definition Classes
    NamedDomainElement
  87. def nameField: Field
    Attributes
    protected
    Definition Classes
    Shape → NamedDomainElement
  88. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  89. def not: Shape
    Definition Classes
    Shape
  90. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  91. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  92. def or: Seq[Shape]
    Definition Classes
    Shape
  93. def parameterValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  94. def payloadValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  95. def payloadValidator(shape: Shape, validationMode: ValidationMode): PlatformPayloadValidator
    Attributes
    protected
    Definition Classes
    JsonSchemaSecrets
  96. def position(): Option[LexicalInformation]
    Definition Classes
    AmfElement
  97. def properties: Seq[PropertyShape]
  98. def propertyNames: Shape
  99. val ramlSyntaxKey: String
    Definition Classes
    NodeShape → 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): NodeShape.this.type
    Definition Classes
    AmfObject
  108. def set(field: Field, value: AmfElement): NodeShape.this.type
    Definition Classes
    AmfObject
  109. def set(field: Field, values: Seq[String]): NodeShape.this.type
    Definition Classes
    AmfObject
  110. def set(field: Field, value: Float): NodeShape.this.type
    Definition Classes
    AmfObject
  111. def set(field: Field, value: Double): NodeShape.this.type
    Definition Classes
    AmfObject
  112. def set(field: Field, value: Int): NodeShape.this.type
    Definition Classes
    AmfObject
  113. def set(field: Field, value: Boolean): NodeShape.this.type
    Definition Classes
    AmfObject
  114. def set(field: Field, value: String): NodeShape.this.type
    Definition Classes
    AmfObject
  115. def setArray(field: Field, values: Seq[AmfElement], annotations: Annotations): NodeShape.this.type
    Definition Classes
    AmfObject
  116. def setArray(field: Field, values: Seq[AmfElement]): NodeShape.this.type
    Definition Classes
    AmfObject
  117. def setArrayWithoutId(field: Field, values: Seq[AmfElement], annotations: Annotations): NodeShape.this.type
    Definition Classes
    AmfObject
  118. def setArrayWithoutId(field: Field, values: Seq[AmfElement]): NodeShape.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): NodeShape.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]): NodeShape.this.type
    Definition Classes
    Shape
  147. def withClosed(closed: Boolean): NodeShape.this.type
  148. def withComment(comment: String): NodeShape.this.type
    Definition Classes
    AnyShape
  149. def withCustomDomainProperties(extensions: Seq[DomainExtension]): NodeShape.this.type
    Definition Classes
    DomainElement
  150. def withCustomDomainProperty(extensions: DomainExtension): NodeShape.this.type
    Definition Classes
    DomainElement
  151. def withCustomShapeProperties(properties: Seq[ShapeExtension]): NodeShape.this.type
    Definition Classes
    Shape
  152. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  153. def withCustomShapePropertyDefinitions(propertyDefinitions: Seq[PropertyShape]): NodeShape.this.type
    Definition Classes
    Shape
  154. def withDefault(default: DataNode): NodeShape.this.type
    Definition Classes
    Shape
  155. def withDefaultStr(value: String): NodeShape.this.type
    Definition Classes
    Shape
  156. def withDependencies(dependencies: Seq[PropertyDependencies]): NodeShape.this.type
  157. def withDependency(): PropertyDependencies
  158. def withDeprecated(deprecated: Boolean): NodeShape.this.type
    Definition Classes
    Shape
  159. def withDescription(description: String): NodeShape.this.type
    Definition Classes
    Shape
  160. def withDiscriminator(discriminator: String): NodeShape.this.type
  161. def withDiscriminatorMapping(mappings: Seq[IriTemplateMapping]): NodeShape.this.type
  162. def withDiscriminatorValue(value: String): NodeShape.this.type
  163. def withDisplayName(name: String): NodeShape.this.type
    Definition Classes
    Shape
  164. def withDocumentation(documentation: CreativeWork): NodeShape.this.type
    Definition Classes
    AnyShape
  165. def withElse(elseShape: Shape): NodeShape.this.type
    Definition Classes
    Shape
  166. def withExample(name: Option[String]): Example
    Definition Classes
    AnyShape
  167. def withExamples(examples: Seq[Example]): NodeShape.this.type
    Definition Classes
    AnyShape
  168. def withExtends(extend: Seq[DomainElement]): NodeShape.this.type
    Definition Classes
    DomainElement
  169. def withId(value: String): NodeShape.this.type
    Definition Classes
    AmfObject
  170. def withIf(ifShape: Shape): NodeShape.this.type
    Definition Classes
    Shape
  171. def withInherits(inherits: Seq[Shape]): NodeShape.this.type
    Definition Classes
    Shape
  172. def withInheritsObject(name: String): NodeShape
  173. def withInheritsScalar(name: String): ScalarShape
  174. def withLinkLabel(label: String): NodeShape.this.type
    Definition Classes
    Linkable
  175. def withLinkTarget(target: DomainElement): NodeShape.this.type
    Definition Classes
    Linkable
  176. def withMaxProperties(max: Int): NodeShape.this.type
  177. def withMinProperties(min: Int): NodeShape.this.type
  178. def withName(name: String, a: Annotations): NodeShape.this.type
    Definition Classes
    NamedDomainElement
  179. def withNot(shape: Shape): NodeShape.this.type
    Definition Classes
    Shape
  180. def withOr(subShapes: Seq[Shape]): NodeShape.this.type
    Definition Classes
    Shape
  181. def withProperties(properties: Seq[PropertyShape]): NodeShape.this.type
  182. def withProperty(name: String): PropertyShape
  183. def withPropertyNames(shape: Shape): NodeShape.this.type
  184. def withReadOnly(readOnly: Boolean): NodeShape.this.type
    Definition Classes
    Shape
  185. def withReference(id: String): NodeShape.this.type
    Definition Classes
    ExternalSourceElement
  186. def withSupportsRecursion(recursive: Boolean): NodeShape.this.type
    Definition Classes
    Linkable
  187. def withThen(thenShape: Shape): NodeShape.this.type
    Definition Classes
    Shape
  188. def withValues(values: Seq[DataNode]): NodeShape.this.type
    Definition Classes
    Shape
  189. def withWriteOnly(writeOnly: Boolean): NodeShape.this.type
    Definition Classes
    Shape
  190. def withXMLSerialization(xmlSerialization: XMLSerializer): NodeShape.this.type
    Definition Classes
    AnyShape
  191. def withXone(subShapes: Seq[Shape]): NodeShape.this.type
    Definition Classes
    Shape
  192. def writeOnly: BoolField
    Definition Classes
    Shape
  193. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
  194. 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