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