class AnyShape extends Shape

Annotations
@JSExportAll()
Linear Supertypes
Shape, NamedDomainElement, Linkable, DomainElement, PlatformSecrets, AmfObjectWrapper, Annotable, AnyRef, Any
Known Subclasses
ArrayShape, DataArrangeShape, FileShape, MatrixShape, NilShape, NodeShape, ScalarShape, SchemaShape, TupleShape, UnionShape
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AnyShape
  2. Shape
  3. NamedDomainElement
  4. Linkable
  5. DomainElement
  6. PlatformSecrets
  7. AmfObjectWrapper
  8. Annotable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

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
  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

  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.

  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. def comment: StrField
  12. def customDomainProperties: convert.CoreClientConverters.ClientList[DomainExtension]
    Definition Classes
    DomainElement
  13. def customShapeProperties: convert.CoreClientConverters.ClientList[ShapeExtension]
    Definition Classes
    Shape
  14. def customShapePropertyDefinitions: convert.CoreClientConverters.ClientList[PropertyShape]
    Definition Classes
    Shape
  15. def defaultValue: DataNode
    Definition Classes
    Shape
  16. def defaultValueStr: StrField
    Definition Classes
    Shape
  17. def deprecated: BoolField
    Definition Classes
    Shape
  18. def description: StrField
    Definition Classes
    Shape
  19. def displayName: StrField
    Definition Classes
    Shape
  20. def documentation: CreativeWork
  21. def elseShape: Shape
    Definition Classes
    Shape
  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  24. def examples: ClientList[Example]
  25. def extendsNode: convert.CoreClientConverters.ClientList[DomainElement]
    Definition Classes
    DomainElement
  26. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  27. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. def graph(): Graph
    Definition Classes
    DomainElement
  29. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  30. def id: String
    Definition Classes
    DomainElement
  31. def ifShape: Shape
    Definition Classes
    Shape
  32. def inherits: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape
  33. def inlined(): Boolean
  34. 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

  35. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  36. def isLink: Boolean
    Definition Classes
    Linkable
  37. def link[T](label: Option[String]): T
    Definition Classes
    Linkable
  38. def linkCopy(): AnyShape
    Definition Classes
    AnyShape → Linkable
  39. def linkLabel: StrField
    Definition Classes
    Linkable
  40. def linkTarget: convert.CoreClientConverters.ClientOption[DomainElement]
    Definition Classes
    Linkable
  41. def name: StrField
    Definition Classes
    Shape → NamedDomainElement
  42. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  43. def not: Shape
    Definition Classes
    Shape
  44. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  45. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  46. def or: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape
  47. def parameterValidator(mediaType: String, env: Environment): ClientOption[PayloadValidator]
  48. def parameterValidator(mediaType: String): ClientOption[PayloadValidator]
  49. def payloadValidator(mediaType: String, env: Environment): ClientOption[PayloadValidator]
  50. def payloadValidator(mediaType: String): ClientOption[PayloadValidator]
  51. val platform: Platform
    Definition Classes
    PlatformSecrets
  52. def position: Range
    Definition Classes
    DomainElement
  53. def readOnly: BoolField
    Definition Classes
    Shape
  54. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  55. def thenShape: Shape
    Definition Classes
    Shape
  56. 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

  57. 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.

  58. def toString(): String
    Definition Classes
    AnyRef → Any
  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.

  60. def validate(fragment: PayloadFragment): ClientFuture[ValidationReport]
  61. def validate(fragment: PayloadFragment, env: Environment): ClientFuture[ValidationReport]
  62. def validate(payload: String): ClientFuture[ValidationReport]
  63. def validate(payload: String, env: Environment): ClientFuture[ValidationReport]
  64. def validateParameter(payload: String): ClientFuture[ValidationReport]
  65. def validateParameter(payload: String, env: Environment): ClientFuture[ValidationReport]
  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
    @throws( ... ) @native()
  70. def withAnd(subShapes: convert.CoreClientConverters.ClientList[Shape]): AnyShape.this.type
    Definition Classes
    Shape
  71. def withComment(comment: String): AnyShape.this.type
  72. def withCustomDomainProperties(extensions: convert.CoreClientConverters.ClientList[DomainExtension]): AnyShape.this.type
    Definition Classes
    DomainElement
  73. def withCustomShapeProperties(customShapeProperties: convert.CoreClientConverters.ClientList[ShapeExtension]): AnyShape.this.type
    Definition Classes
    Shape
  74. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  75. def withCustomShapePropertyDefinitions(propertyDefinitions: convert.CoreClientConverters.ClientList[PropertyShape]): AnyShape.this.type
    Definition Classes
    Shape
  76. def withDefaultStr(value: String): AnyShape.this.type
    Definition Classes
    Shape
  77. def withDefaultValue(default: DataNode): AnyShape.this.type
    Definition Classes
    Shape
  78. def withDeprecated(deprecated: Boolean): AnyShape.this.type
    Definition Classes
    Shape
  79. def withDescription(description: String): AnyShape.this.type
    Definition Classes
    Shape
  80. def withDisplayName(name: String): AnyShape.this.type
    Definition Classes
    Shape
  81. def withDocumentation(documentation: CreativeWork): AnyShape.this.type
  82. def withElse(elseShape: Shape): AnyShape.this.type
    Definition Classes
    Shape
  83. def withExample(mediaType: String): Example
  84. def withExamples(examples: ClientList[Example]): AnyShape.this.type
  85. def withExtendsNode(extension: convert.CoreClientConverters.ClientList[ParametrizedDeclaration]): AnyShape.this.type
    Definition Classes
    DomainElement
  86. def withId(id: String): AnyShape.this.type
    Definition Classes
    DomainElement
  87. def withIf(ifShape: Shape): AnyShape.this.type
    Definition Classes
    Shape
  88. def withInherits(inherits: convert.CoreClientConverters.ClientList[Shape]): AnyShape.this.type
    Definition Classes
    Shape
  89. def withLinkLabel(label: String): AnyShape.this.type
    Definition Classes
    Linkable
  90. def withLinkTarget(target: DomainElement with Linkable): AnyShape.this.type
    Definition Classes
    Linkable
  91. def withName(name: String): AnyShape.this.type
    Definition Classes
    Shape → NamedDomainElement
  92. def withNode(shape: Shape): AnyShape.this.type
    Definition Classes
    Shape
  93. def withOr(subShapes: convert.CoreClientConverters.ClientList[Shape]): AnyShape.this.type
    Definition Classes
    Shape
  94. def withReadOnly(readOnly: Boolean): AnyShape.this.type
    Definition Classes
    Shape
  95. def withThen(thenShape: Shape): AnyShape.this.type
    Definition Classes
    Shape
  96. def withValues(values: convert.CoreClientConverters.ClientList[DataNode]): AnyShape.this.type
    Definition Classes
    Shape
  97. def withWriteOnly(writeOnly: Boolean): AnyShape.this.type
    Definition Classes
    Shape
  98. def withXMLSerialization(xmlSerialization: XMLSerializer): AnyShape.this.type
  99. def withXone(subShapes: convert.CoreClientConverters.ClientList[Shape]): AnyShape.this.type
    Definition Classes
    Shape
  100. def writeOnly: BoolField
    Definition Classes
    Shape
  101. def xmlSerialization: XMLSerializer
  102. def xone: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape

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