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(options: ShapeRenderOptions): String
    Definition Classes
    AnyShape
  8. 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
  9. def buildRamlDatatype(): String

    Forces a new RAML Data Type generation, no matter if the shape was parsed from that kind of expression or if was previously generated.

    Forces a new RAML Data Type generation, no matter if the shape was parsed from that kind of expression or if was previously generated. Stores the result for futures toRamlDatatype invocations. Call this method to generate a new RAML Data Type when this instance was mutated. Proxies call to internal AnyShape.toRamlDatatype.

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

    If the shape was parsed of RAML, or a new RAML has been previously generated, returns that value, otherwise generates a new RAML Data Type and stores the value for futures invocations.

    If the shape was parsed of RAML, or a new RAML has been previously generated, returns that value, otherwise generates a new RAML Data Type and stores the value for futures invocations. Proxies call to internal AnyShape.toRamlDatatype.

    Definition Classes
    AnyShape
  53. 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
  54. def validate(fragment: PayloadFragment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  55. def validate(fragment: PayloadFragment, env: Environment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  56. def validate(payload: String): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  57. def validate(payload: String, env: Environment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  58. def validateParameter(payload: String): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  59. def validateParameter(payload: String, env: Environment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  60. def values: convert.CoreClientConverters.ClientList[DataNode]
    Definition Classes
    Shape
  61. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  64. def withAnd(subShapes: convert.CoreClientConverters.ClientList[Shape]): SchemaShape.this.type
    Definition Classes
    Shape
  65. def withCustomDomainProperties(extensions: convert.CoreClientConverters.ClientList[DomainExtension]): SchemaShape.this.type
    Definition Classes
    DomainElement
  66. def withCustomShapeProperties(customShapeProperties: convert.CoreClientConverters.ClientList[ShapeExtension]): SchemaShape.this.type
    Definition Classes
    Shape
  67. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  68. def withCustomShapePropertyDefinitions(propertyDefinitions: convert.CoreClientConverters.ClientList[PropertyShape]): SchemaShape.this.type
    Definition Classes
    Shape
  69. def withDefaultStr(value: String): SchemaShape.this.type
    Definition Classes
    Shape
  70. def withDefaultValue(default: DataNode): SchemaShape.this.type
    Definition Classes
    Shape
  71. def withDescription(description: String): SchemaShape.this.type
    Definition Classes
    Shape
  72. def withDisplayName(name: String): SchemaShape.this.type
    Definition Classes
    Shape
  73. def withDocumentation(documentation: CreativeWork): SchemaShape.this.type
    Definition Classes
    AnyShape
  74. def withExample(mediaType: String): Example
    Definition Classes
    AnyShape
  75. def withExamples(examples: ClientList[Example]): SchemaShape.this.type
    Definition Classes
    AnyShape
  76. def withExtendsNode(extension: convert.CoreClientConverters.ClientList[ParametrizedDeclaration]): SchemaShape.this.type
    Definition Classes
    DomainElement
  77. def withId(id: String): SchemaShape.this.type
    Definition Classes
    DomainElement
  78. def withInherits(inherits: convert.CoreClientConverters.ClientList[Shape]): SchemaShape.this.type
    Definition Classes
    Shape
  79. def withLinkLabel(label: String): SchemaShape.this.type
    Definition Classes
    Linkable
  80. def withLinkTarget(target: DomainElement with Linkable): SchemaShape.this.type
    Definition Classes
    Linkable
  81. def withMediatype(mediaType: String): SchemaShape.this.type
  82. def withName(name: String): SchemaShape.this.type
    Definition Classes
    Shape → NamedDomainElement
  83. def withNode(shape: Shape): SchemaShape.this.type
    Definition Classes
    Shape
  84. def withOr(subShapes: convert.CoreClientConverters.ClientList[Shape]): SchemaShape.this.type
    Definition Classes
    Shape
  85. def withRaw(text: String): SchemaShape.this.type
  86. def withValues(values: convert.CoreClientConverters.ClientList[DataNode]): SchemaShape.this.type
    Definition Classes
    Shape
  87. def withXMLSerialization(xmlSerialization: XMLSerializer): SchemaShape.this.type
    Definition Classes
    AnyShape
  88. def withXone(subShapes: convert.CoreClientConverters.ClientList[Shape]): SchemaShape.this.type
    Definition Classes
    Shape
  89. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
  90. 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