class AnyShape extends Shape with ValidatorAware with PlatformSecrets

Linear Supertypes
ValidatorAware, Shape, NamedDomainElement, Linkable, DomainElement, CustomizableElement, 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. ValidatorAware
  3. Shape
  4. NamedDomainElement
  5. Linkable
  6. DomainElement
  7. CustomizableElement
  8. PlatformSecrets
  9. AmfObjectWrapper
  10. Annotable
  11. AnyRef
  12. 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, exec: BaseExecutionEnvironment): String
  8. def buildJsonSchema(options: ShapeRenderOptions): String
    Annotations
    @JSExport()
  9. def buildJsonSchema(exec: BaseExecutionEnvironment): String
  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

    Annotations
    @JSExport()
  11. def buildRamlDatatype(exec: BaseExecutionEnvironment): String
  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.

    Annotations
    @JSExport()
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  14. def comment: StrField
    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 defaultValue: DataNode
    Definition Classes
    Shape
  19. def defaultValueStr: StrField
    Definition Classes
    Shape
  20. def deprecated: BoolField
    Definition Classes
    Shape
  21. def description: StrField
    Definition Classes
    Shape
  22. def displayName: StrField
    Definition Classes
    Shape
  23. def documentation: CreativeWork
    Annotations
    @JSExport()
  24. def elseShape: Shape
    Definition Classes
    Shape
  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  27. def examples: ClientList[Example]
    Annotations
    @JSExport()
  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. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  31. def graph(): Graph
    Definition Classes
    DomainElement
  32. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  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
    Annotations
    @JSExport()
  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

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

    Annotations
    @JSExport()
  64. def toRamlDatatype(exec: BaseExecutionEnvironment): String
  65. 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.

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

    Annotations
    @JSExport()
  68. def validate(fragment: PayloadFragment, env: Environment, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
  69. def validate(fragment: PayloadFragment, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
  70. def validate(fragment: PayloadFragment, env: Environment): ClientFuture[ValidationReport]
    Annotations
    @JSExport()
  71. def validate(fragment: PayloadFragment): ClientFuture[ValidationReport]
    Annotations
    @JSExport()
  72. def validate(payload: String, env: Environment, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
  73. def validate(payload: String, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
  74. def validate(payload: String, env: Environment): ClientFuture[ValidationReport]
    Annotations
    @JSExport()
  75. def validate(payload: String): ClientFuture[ValidationReport]
    Annotations
    @JSExport()
  76. def validateParameter(payload: String, env: Environment, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
  77. def validateParameter(payload: String, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
  78. def validateParameter(payload: String, env: Environment): ClientFuture[ValidationReport]
    Annotations
    @JSExport()
  79. def validateParameter(payload: String): ClientFuture[ValidationReport]
    Annotations
    @JSExport()
  80. def values: convert.CoreClientConverters.ClientList[DataNode]
    Definition Classes
    Shape
  81. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  82. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  83. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  84. def withAnd(subShapes: convert.CoreClientConverters.ClientList[Shape]): AnyShape.this.type
    Definition Classes
    Shape
  85. def withComment(comment: String): AnyShape.this.type
    Annotations
    @JSExport()
  86. def withCustomDomainProperties(extensions: convert.CoreClientConverters.ClientList[DomainExtension]): AnyShape.this.type
    Definition Classes
    DomainElement → CustomizableElement
  87. def withCustomShapeProperties(customShapeProperties: convert.CoreClientConverters.ClientList[ShapeExtension]): AnyShape.this.type
    Definition Classes
    Shape
  88. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  89. def withCustomShapePropertyDefinitions(propertyDefinitions: convert.CoreClientConverters.ClientList[PropertyShape]): AnyShape.this.type
    Definition Classes
    Shape
  90. def withDefaultStr(value: String): AnyShape.this.type
    Definition Classes
    Shape
  91. def withDefaultValue(defaultVal: DataNode): AnyShape.this.type
    Definition Classes
    Shape
  92. def withDeprecated(deprecated: Boolean): AnyShape.this.type
    Definition Classes
    Shape
  93. def withDescription(description: String): AnyShape.this.type
    Definition Classes
    Shape
  94. def withDisplayName(name: String): AnyShape.this.type
    Definition Classes
    Shape
  95. def withDocumentation(documentation: CreativeWork): AnyShape.this.type
    Annotations
    @JSExport()
  96. def withElse(elseShape: Shape): AnyShape.this.type
    Definition Classes
    Shape
  97. def withExample(mediaType: String): Example
    Annotations
    @JSExport()
  98. def withExamples(examples: ClientList[Example]): AnyShape.this.type
    Annotations
    @JSExport()
  99. def withExtendsNode(extension: convert.CoreClientConverters.ClientList[ParametrizedDeclaration]): AnyShape.this.type
    Definition Classes
    DomainElement
  100. def withId(id: String): AnyShape.this.type
    Definition Classes
    DomainElement
  101. def withIf(ifShape: Shape): AnyShape.this.type
    Definition Classes
    Shape
  102. def withInherits(inherits: convert.CoreClientConverters.ClientList[Shape]): AnyShape.this.type
    Definition Classes
    Shape
  103. def withIsExternalLink(isExternalLink: Boolean): DomainElement
    Definition Classes
    DomainElement
  104. def withLinkLabel(label: String): AnyShape.this.type
    Definition Classes
    Linkable
  105. def withLinkTarget(target: DomainElement with Linkable): AnyShape.this.type
    Definition Classes
    Linkable
  106. def withName(name: String): AnyShape.this.type
    Definition Classes
    Shape → NamedDomainElement
  107. def withNode(shape: Shape): AnyShape.this.type
    Definition Classes
    Shape
  108. def withOr(subShapes: convert.CoreClientConverters.ClientList[Shape]): AnyShape.this.type
    Definition Classes
    Shape
  109. def withReadOnly(readOnly: Boolean): AnyShape.this.type
    Definition Classes
    Shape
  110. def withThen(thenShape: Shape): AnyShape.this.type
    Definition Classes
    Shape
  111. def withValues(values: convert.CoreClientConverters.ClientList[DataNode]): AnyShape.this.type
    Definition Classes
    Shape
  112. def withWriteOnly(writeOnly: Boolean): AnyShape.this.type
    Definition Classes
    Shape
  113. def withXMLSerialization(xmlSerialization: XMLSerializer): AnyShape.this.type
    Annotations
    @JSExport()
  114. def withXone(subShapes: convert.CoreClientConverters.ClientList[Shape]): AnyShape.this.type
    Definition Classes
    Shape
  115. def writeOnly: BoolField
    Definition Classes
    Shape
  116. def xmlSerialization: XMLSerializer
    Annotations
    @JSExport()
  117. def xone: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape

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