c

amf.client.model.domain

SchemaShape

case class SchemaShape(_internal: plugins.domain.shapes.models.SchemaShape) extends AnyShape with Product with Serializable

Annotations
@JSExportAll()
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyShape, Shape, NamedDomainElement, Linkable, DomainElement, PlatformSecrets, AmfObjectWrapper, Annotable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SchemaShape
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyShape
  7. Shape
  8. NamedDomainElement
  9. Linkable
  10. DomainElement
  11. PlatformSecrets
  12. AmfObjectWrapper
  13. Annotable
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SchemaShape()
    Annotations
    @JSExportTopLevel( "model.domain.SchemaShape" )
  2. new SchemaShape(_internal: plugins.domain.shapes.models.SchemaShape)

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 and: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape
  5. def annotations(): Annotations
    Definition Classes
    AmfObjectWrapper → Annotable
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def buildJsonSchema(): String

    Force a new json schema generation, no matter if the shape was parsed from that kind of expression or if was previously generated.

    Force a new json schema generation, no matter if the shape was parsed from that kind of expression or if was previously generated. Stores the result for futures toJsonSchema invocations. Should use this method when you have mutated this instance

    Definition Classes
    AnyShape
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. def customDomainProperties: convert.CoreClientConverters.ClientList[DomainExtension]
    Definition Classes
    DomainElement
  10. def defaultValue: DataNode
    Definition Classes
    Shape
  11. def defaultValueStr: StrField
    Definition Classes
    Shape
  12. def description: StrField
    Definition Classes
    Shape
  13. def displayName: StrField
    Definition Classes
    Shape
  14. def documentation: CreativeWork
    Definition Classes
    AnyShape
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def examples: ClientList[Example]
    Definition Classes
    AnyShape
  17. def extendsNode: convert.CoreClientConverters.ClientList[DomainElement]
    Definition Classes
    DomainElement
  18. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def graph(): Graph
    Definition Classes
    DomainElement
  21. def id: String
    Definition Classes
    DomainElement
  22. def inherits: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape
  23. 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
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def isLink: Boolean
    Definition Classes
    Linkable
  26. def link[T](label: Option[String]): T
    Definition Classes
    Linkable
  27. def linkCopy(): SchemaShape
    Definition Classes
    SchemaShapeAnyShape → Linkable
  28. def linkLabel: StrField
    Definition Classes
    Linkable
  29. def linkTarget: convert.CoreClientConverters.ClientOption[DomainElement]
    Definition Classes
    Linkable
  30. def location: convert.CoreClientConverters.ClientOption[String]
  31. def mediaType: StrField
  32. def name: StrField
    Definition Classes
    Shape → NamedDomainElement
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. def not: Shape
    Definition Classes
    Shape
  35. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. def or: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape
  38. def payloadValidator(): PayloadValidator
    Definition Classes
    AnyShape
  39. val platform: Platform
    Definition Classes
    PlatformSecrets
  40. def position: Range
    Definition Classes
    DomainElement
  41. def raw: StrField
  42. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  43. def toJsonSchema: String

    if the shape was parsed of a json schema, or has been previously generated a new json schema, returns thar value, otherwise generate a new json schema and store the value for futures invocations

    if the shape was parsed of a json schema, or has been previously generated a new json schema, returns thar value, otherwise generate a new json schema and store the value for futures invocations

    Definition Classes
    AnyShape
  44. def trackedExample(trackId: String): ClientOption[Example]

    trackId

    parent id of the original payload type with simpleinheritance and the searched example.

    returns

    A ClientOption of the original inlined example, or empty if there is not any example with that track information annotated.

    Definition Classes
    AnyShape
  45. def validate(fragment: PayloadFragment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  46. def validate(fragment: PayloadFragment, env: Environment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  47. def validate(payload: String): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  48. def validate(payload: String, env: Environment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  49. def validateParameter(payload: String): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  50. def validateParameter(payload: String, env: Environment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  51. def values: convert.CoreClientConverters.ClientList[DataNode]
    Definition Classes
    Shape
  52. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  53. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  54. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  55. def withAnd(subShapes: convert.CoreClientConverters.ClientList[Shape]): SchemaShape.this.type
    Definition Classes
    Shape
  56. def withCustomDomainProperties(extensions: convert.CoreClientConverters.ClientList[DomainExtension]): SchemaShape.this.type
    Definition Classes
    DomainElement
  57. def withDefaultStr(value: String): SchemaShape.this.type
    Definition Classes
    Shape
  58. def withDefaultValue(default: DataNode): SchemaShape.this.type
    Definition Classes
    Shape
  59. def withDescription(description: String): SchemaShape.this.type
    Definition Classes
    Shape
  60. def withDisplayName(name: String): SchemaShape.this.type
    Definition Classes
    Shape
  61. def withDocumentation(documentation: CreativeWork): SchemaShape.this.type
    Definition Classes
    AnyShape
  62. def withExample(mediaType: String): Example
    Definition Classes
    AnyShape
  63. def withExamples(examples: ClientList[Example]): SchemaShape.this.type
    Definition Classes
    AnyShape
  64. def withExtendsNode(extension: convert.CoreClientConverters.ClientList[ParametrizedDeclaration]): SchemaShape.this.type
    Definition Classes
    DomainElement
  65. def withId(id: String): SchemaShape.this.type
    Definition Classes
    DomainElement
  66. def withInherits(inherits: convert.CoreClientConverters.ClientList[Shape]): SchemaShape.this.type
    Definition Classes
    Shape
  67. def withLinkLabel(label: String): SchemaShape.this.type
    Definition Classes
    Linkable
  68. def withLinkTarget(target: DomainElement with Linkable): SchemaShape.this.type
    Definition Classes
    Linkable
  69. def withMediatype(mediaType: String): SchemaShape.this.type
  70. def withName(name: String): SchemaShape.this.type
    Definition Classes
    Shape → NamedDomainElement
  71. def withNode(shape: Shape): SchemaShape.this.type
    Definition Classes
    Shape
  72. def withOr(subShapes: convert.CoreClientConverters.ClientList[Shape]): SchemaShape.this.type
    Definition Classes
    Shape
  73. def withRaw(text: String): SchemaShape.this.type
  74. def withValues(values: convert.CoreClientConverters.ClientList[String]): SchemaShape.this.type
    Definition Classes
    Shape
  75. def withXMLSerialization(xmlSerialization: XMLSerializer): SchemaShape.this.type
    Definition Classes
    AnyShape
  76. def withXone(subShapes: convert.CoreClientConverters.ClientList[Shape]): SchemaShape.this.type
    Definition Classes
    Shape
  77. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
  78. def xone: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyShape

Inherited from Shape

Inherited from NamedDomainElement

Inherited from Linkable

Inherited from DomainElement

Inherited from PlatformSecrets

Inherited from AmfObjectWrapper

Inherited from Annotable

Inherited from AnyRef

Inherited from Any

Ungrouped