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