c

amf.client.model.domain

ScalarShape

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

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

Instance Constructors

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

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, exec: BaseExecutionEnvironment): String
    Definition Classes
    AnyShape
  8. def buildJsonSchema(options: ShapeRenderOptions): String
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  9. def buildJsonSchema(exec: BaseExecutionEnvironment): String
    Definition Classes
    AnyShape
  10. 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
    Annotations
    @JSExport()
  11. def buildRamlDatatype(exec: BaseExecutionEnvironment): String
    Definition Classes
    AnyShape
  12. 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
    Annotations
    @JSExport()
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  14. def comment: StrField
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  15. def customDomainProperties: convert.CoreClientConverters.ClientList[DomainExtension]
    Definition Classes
    DomainElement → CustomizableElement
  16. def customShapeProperties: convert.CoreClientConverters.ClientList[ShapeExtension]
    Definition Classes
    Shape
  17. def customShapePropertyDefinitions: convert.CoreClientConverters.ClientList[PropertyShape]
    Definition Classes
    Shape
  18. def dataType: StrField
  19. def defaultValue: DataNode
    Definition Classes
    Shape
  20. def defaultValueStr: StrField
    Definition Classes
    Shape
  21. def deprecated: BoolField
    Definition Classes
    Shape
  22. def description: StrField
    Definition Classes
    Shape
  23. def displayName: StrField
    Definition Classes
    Shape
  24. def documentation: CreativeWork
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  25. def elseShape: Shape
    Definition Classes
    Shape
  26. def encoding: StrField
  27. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def examples: ClientList[Example]
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  29. def exclusiveMaximum: BoolField
  30. def exclusiveMinimum: BoolField
  31. def extendsNode: convert.CoreClientConverters.ClientList[DomainElement]
    Definition Classes
    DomainElement
  32. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  33. def format: StrField
  34. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  35. def graph(): Graph
    Definition Classes
    DomainElement
  36. def id: String
    Definition Classes
    DomainElement
  37. def ifShape: Shape
    Definition Classes
    Shape
  38. def inherits: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape
  39. def inlined(): Boolean
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  40. 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
    Annotations
    @JSExport()
  41. def isExternalLink: BoolField
    Definition Classes
    DomainElement
  42. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  43. def isLink: Boolean
    Definition Classes
    Linkable
  44. def link[T](label: Option[String]): T
    Definition Classes
    Linkable
  45. def linkCopy(): ScalarShape
    Definition Classes
    ScalarShape → AnyShape → Linkable
  46. def linkLabel: StrField
    Definition Classes
    Linkable
  47. def linkTarget: convert.CoreClientConverters.ClientOption[DomainElement]
    Definition Classes
    Linkable
  48. def maxLength: IntField
  49. def maximum: DoubleField
  50. def mediaType: StrField
  51. def minLength: IntField
  52. def minimum: DoubleField
  53. def multipleOf: DoubleField
  54. def name: StrField
    Definition Classes
    Shape → NamedDomainElement
  55. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  56. def not: Shape
    Definition Classes
    Shape
  57. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  58. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  59. def or: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape
  60. def parameterValidator(mediaType: String, env: Environment): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
    Annotations
    @JSExport()
  61. def parameterValidator(mediaType: String, exec: BaseExecutionEnvironment): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
  62. def parameterValidator(mediaType: String): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
    Annotations
    @JSExport()
  63. def pattern: StrField
  64. def payloadValidator(mediaType: String, env: Environment): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
    Annotations
    @JSExport()
  65. def payloadValidator(mediaType: String, exec: BaseExecutionEnvironment): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
  66. def payloadValidator(mediaType: String): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
    Annotations
    @JSExport()
  67. val platform: Platform
    Definition Classes
    PlatformSecrets
  68. def position: Range
    Definition Classes
    DomainElement
  69. def readOnly: BoolField
    Definition Classes
    Shape
  70. def schema: Shape
  71. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  72. def thenShape: Shape
    Definition Classes
    Shape
  73. def toJsonSchema(exec: BaseExecutionEnvironment): String
    Definition Classes
    AnyShape
  74. 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
    Annotations
    @JSExport()
  75. def toRamlDatatype(exec: BaseExecutionEnvironment): String
    Definition Classes
    AnyShape
  76. 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
    Annotations
    @JSExport()
  77. 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
    Annotations
    @JSExport()
  78. def validate(fragment: PayloadFragment, env: Environment, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  79. def validate(fragment: PayloadFragment, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  80. def validate(fragment: PayloadFragment, env: Environment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  81. def validate(fragment: PayloadFragment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  82. def validate(payload: String, env: Environment, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  83. def validate(payload: String, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  84. def validate(payload: String, env: Environment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  85. def validate(payload: String): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  86. def validateParameter(payload: String, env: Environment, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  87. def validateParameter(payload: String, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  88. def validateParameter(payload: String, env: Environment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  89. def validateParameter(payload: String): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  90. def values: convert.CoreClientConverters.ClientList[DataNode]
    Definition Classes
    Shape
  91. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  92. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  93. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  94. def withAnd(subShapes: convert.CoreClientConverters.ClientList[Shape]): ScalarShape.this.type
    Definition Classes
    Shape
  95. def withComment(comment: String): ScalarShape.this.type
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  96. def withCustomDomainProperties(extensions: convert.CoreClientConverters.ClientList[DomainExtension]): ScalarShape.this.type
    Definition Classes
    DomainElement → CustomizableElement
  97. def withCustomShapeProperties(customShapeProperties: convert.CoreClientConverters.ClientList[ShapeExtension]): ScalarShape.this.type
    Definition Classes
    Shape
  98. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  99. def withCustomShapePropertyDefinitions(propertyDefinitions: convert.CoreClientConverters.ClientList[PropertyShape]): ScalarShape.this.type
    Definition Classes
    Shape
  100. def withDataType(dataType: String): ScalarShape.this.type
  101. def withDefaultStr(value: String): ScalarShape.this.type
    Definition Classes
    Shape
  102. def withDefaultValue(defaultVal: DataNode): ScalarShape.this.type
    Definition Classes
    Shape
  103. def withDeprecated(deprecated: Boolean): ScalarShape.this.type
    Definition Classes
    Shape
  104. def withDescription(description: String): ScalarShape.this.type
    Definition Classes
    Shape
  105. def withDisplayName(name: String): ScalarShape.this.type
    Definition Classes
    Shape
  106. def withDocumentation(documentation: CreativeWork): ScalarShape.this.type
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  107. def withElse(elseShape: Shape): ScalarShape.this.type
    Definition Classes
    Shape
  108. def withEncoding(encoding: String): ScalarShape.this.type
  109. def withExample(mediaType: String): Example
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  110. def withExamples(examples: ClientList[Example]): ScalarShape.this.type
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  111. def withExclusiveMaximum(max: Boolean): ScalarShape.this.type
  112. def withExclusiveMinimum(min: Boolean): ScalarShape.this.type
  113. def withExtendsNode(extension: convert.CoreClientConverters.ClientList[ParametrizedDeclaration]): ScalarShape.this.type
    Definition Classes
    DomainElement
  114. def withFormat(format: String): ScalarShape.this.type
  115. def withId(id: String): ScalarShape.this.type
    Definition Classes
    DomainElement
  116. def withIf(ifShape: Shape): ScalarShape.this.type
    Definition Classes
    Shape
  117. def withInherits(inherits: convert.CoreClientConverters.ClientList[Shape]): ScalarShape.this.type
    Definition Classes
    Shape
  118. def withIsExternalLink(isExternalLink: Boolean): DomainElement
    Definition Classes
    DomainElement
  119. def withLinkLabel(label: String): ScalarShape.this.type
    Definition Classes
    Linkable
  120. def withLinkTarget(target: DomainElement with Linkable): ScalarShape.this.type
    Definition Classes
    Linkable
  121. def withMaxLength(max: Int): ScalarShape.this.type
  122. def withMaximum(max: Double): ScalarShape.this.type
  123. def withMediaType(mediaType: String): ScalarShape.this.type
  124. def withMinLength(min: Int): ScalarShape.this.type
  125. def withMinimum(min: Double): ScalarShape.this.type
  126. def withMultipleOf(multiple: Double): ScalarShape.this.type
  127. def withName(name: String): ScalarShape.this.type
    Definition Classes
    Shape → NamedDomainElement
  128. def withNode(shape: Shape): ScalarShape.this.type
    Definition Classes
    Shape
  129. def withOr(subShapes: convert.CoreClientConverters.ClientList[Shape]): ScalarShape.this.type
    Definition Classes
    Shape
  130. def withPattern(pattern: String): ScalarShape.this.type
  131. def withReadOnly(readOnly: Boolean): ScalarShape.this.type
    Definition Classes
    Shape
  132. def withSchema(schema: Shape): ScalarShape.this.type
  133. def withThen(thenShape: Shape): ScalarShape.this.type
    Definition Classes
    Shape
  134. def withValues(values: convert.CoreClientConverters.ClientList[DataNode]): ScalarShape.this.type
    Definition Classes
    Shape
  135. def withWriteOnly(writeOnly: Boolean): ScalarShape.this.type
    Definition Classes
    Shape
  136. def withXMLSerialization(xmlSerialization: XMLSerializer): ScalarShape.this.type
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  137. def withXone(subShapes: convert.CoreClientConverters.ClientList[Shape]): ScalarShape.this.type
    Definition Classes
    Shape
  138. def writeOnly: BoolField
    Definition Classes
    Shape
  139. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
    Annotations
    @JSExport()
  140. 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 ValidatorAware

Inherited from Shape

Inherited from NamedDomainElement

Inherited from Linkable

Inherited from DomainElement

Inherited from CustomizableElement

Inherited from PlatformSecrets

Inherited from AmfObjectWrapper

Inherited from Annotable

Inherited from AnyRef

Inherited from Any

Ungrouped