case class UnionShape(fields: Fields, annotations: Annotations) extends AnyShape with Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyShape, ExemplifiedDomainElement, DocumentedElement, InheritanceChain, ExternalSourceElement, RamlDatatypeSerializer, JsonSchemaSerializer, PlatformSecrets, ShapeHelpers, JsonSchemaSecrets, Shape, ShapeHelper, NamedDomainElement, Linkable, DomainElement, AmfObject, AmfElement, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UnionShape
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyShape
  7. ExemplifiedDomainElement
  8. DocumentedElement
  9. InheritanceChain
  10. ExternalSourceElement
  11. RamlDatatypeSerializer
  12. JsonSchemaSerializer
  13. PlatformSecrets
  14. ShapeHelpers
  15. JsonSchemaSecrets
  16. Shape
  17. ShapeHelper
  18. NamedDomainElement
  19. Linkable
  20. DomainElement
  21. AmfObject
  22. AmfElement
  23. AnyRef
  24. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new UnionShape(fields: Fields, annotations: Annotations)

Type Members

  1. type FacetsMap = Map[String, PropertyShape]
    Definition Classes
    Shape

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 add(field: Field, value: AmfElement): UnionShape.this.type
    Definition Classes
    AmfObject
  5. def add(other: Annotations): UnionShape.this.type
    Definition Classes
    AmfElement
  6. def add(annotation: Annotation): UnionShape.this.type
    Definition Classes
    AmfElement
  7. def addSubType(shape: Shape): Unit
    Definition Classes
    InheritanceChain
  8. def addSuperType(shape: Shape): Unit
    Definition Classes
    InheritanceChain
  9. def adopted(parent: String, cycle: Seq[String]): UnionShape.this.type
    Definition Classes
    AmfObject
  10. def afterResolve(fatherSyntaxKey: Option[String], resolvedId: String): Unit
    Definition Classes
    Linkable
  11. def and: Seq[Shape]
    Definition Classes
    Shape
  12. val annotations: Annotations
    Definition Classes
    UnionShape → AnyShape → AmfElement
  13. def anyOf: Seq[Shape]
  14. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  15. def buildFixPoint(id: Option[String], name: String, link: Linkable, recursionErrorHandler: Option[ErrorHandler]): RecursiveShape
    Attributes
    protected
    Definition Classes
    ShapeHelpers
  16. def buildJsonSchema(options: ShapeRenderOptions = ShapeRenderOptions(), exec: BaseExecutionEnvironment = ...): String
    Definition Classes
    AnyShape
  17. def buildRamlDatatype(exec: BaseExecutionEnvironment = ...): String

    Generates a new RAML Data Type.

    Generates a new RAML Data Type.

    Definition Classes
    AnyShape
  18. def classConstructor: (Fields, Annotations) ⇒ Linkable with DomainElement

    apply method for create a new instance with fields and annotations.

    apply method for create a new instance with fields and annotations. Aux method for copy

    Attributes
    protected
    Definition Classes
    UnionShape → AnyShape → Linkable
  19. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  20. def cloneAllExamples(cloned: Shape, s: Shape): Unit
    Definition Classes
    ShapeHelpers
  21. def cloneShape(recursionErrorHandler: Option[ErrorHandler], withRecursionBase: Option[String] = None, traversal: ModelTraversalRegistry = ModelTraversalRegistry(), cloneExamples: Boolean = false): UnionShape.this.type
    Definition Classes
    ShapeHelpers
  22. def collectCustomShapePropertyDefinitions(onlyInherited: Boolean, traversed: Set[String]): Seq[FacetsMap]
    Definition Classes
    Shape
  23. def comment: StrField
    Definition Classes
    AnyShape
  24. def componentId: String

    Value , path + field value that is used to compose the id when the object its adopted

    Value , path + field value that is used to compose the id when the object its adopted

    Definition Classes
    UnionShape → AnyShape → AmfObject
  25. def computeSubtypesClosure(): Seq[Shape]
    Attributes
    protected
    Definition Classes
    InheritanceChain
  26. def copyAnyShape(fields: Fields = fields, annotations: Annotations = annotations): AnyShape
    Definition Classes
    AnyShape
  27. def copyElement(a: Annotations): Linkable with DomainElement
    Definition Classes
    Linkable
  28. def copyElement(): Linkable with DomainElement
    Definition Classes
    Linkable
  29. def copyFields(recursionErrorHandler: Option[ErrorHandler], cloned: Shape, recursionBase: Option[String], traversal: ModelTraversalRegistry): Unit
    Attributes
    protected
    Definition Classes
    Shape
  30. def copyShape(): UnionShape.this.type
    Definition Classes
    AnyShape → Shape
  31. def copyShape(a: Annotations): UnionShape.this.type
    Definition Classes
    Shape
  32. def customDomainProperties: Seq[DomainExtension]
    Definition Classes
    DomainElement
  33. def customShapeProperties: Seq[ShapeExtension]
    Definition Classes
    Shape
  34. def customShapePropertyDefinitions: Seq[PropertyShape]
    Definition Classes
    Shape
  35. def default: DataNode
    Definition Classes
    Shape
  36. def defaultString: StrField
    Definition Classes
    Shape
  37. def deprecated: BoolField
    Definition Classes
    Shape
  38. def description: StrField
    Definition Classes
    Shape
  39. def displayName: StrField
    Definition Classes
    Shape
  40. def documentation: CreativeWork
    Definition Classes
    AnyShape
  41. def documentations: Seq[CreativeWork]
    Definition Classes
    AnyShape → DocumentedElement
  42. def effectiveInherits: Seq[Shape]
    Definition Classes
    Shape
  43. def effectiveLinkTarget(links: Seq[String]): DomainElement
    Definition Classes
    Linkable
  44. def effectiveStructuralShapes: Seq[Shape]
    Definition Classes
    InheritanceChain
  45. def elseShape: Shape
    Definition Classes
    Shape
  46. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  47. def examples: Seq[Example]
    Definition Classes
    ExemplifiedDomainElement
  48. def extend: Seq[DomainElement]
    Definition Classes
    DomainElement
  49. def externalSourceID: Option[String]
    Definition Classes
    ShapeHelpers
  50. val fields: Fields
    Definition Classes
    UnionShape → AnyShape → AmfObject
  51. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  52. def fromExternalSource: Boolean
    Definition Classes
    ShapeHelpers
  53. def fromLocal(): Boolean
    Definition Classes
    AmfElement
  54. def fromTypeExpression: Boolean
    Definition Classes
    ShapeHelpers
  55. def generateJsonSchema(element: AnyShape, options: ShapeRenderOptions = ShapeRenderOptions(), exec: BaseExecutionEnvironment): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  56. def generateRamlDatatype(element: AnyShape, exec: BaseExecutionEnvironment): String

    Generates a new RAML Data Type included in RAML 1.0 Library.

    Generates a new RAML Data Type included in RAML 1.0 Library.

    Attributes
    protected
    Definition Classes
    RamlDatatypeSerializer
  57. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  58. lazy val graph: Graph
    Definition Classes
    DomainElement
  59. val id: String
    Definition Classes
    AmfObject
  60. def ifShape: Shape
    Definition Classes
    Shape
  61. val inheritedIds: Seq[String]
    Definition Classes
    InheritanceChain
  62. def inherits: Seq[Shape]
    Definition Classes
    Shape
  63. def inlined: Boolean
    Definition Classes
    AnyShape
  64. 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
  65. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  66. def isLink: Boolean
    Definition Classes
    Linkable
  67. def isLinkToSource: Boolean
    Definition Classes
    ExternalSourceElement
  68. def isTrackedBy(trackId: String): Boolean
    Definition Classes
    AmfElement
  69. val isUnresolved: Boolean
    Definition Classes
    Linkable
  70. def link[T](label: String, annotations: Annotations): T
    Definition Classes
    Linkable
  71. val linkAnnotations: Option[Annotations]
    Definition Classes
    Linkable
  72. def linkCopy(): AnyShape
    Definition Classes
    UnionShape → AnyShape → Linkable
  73. def linkLabel: StrField
    Definition Classes
    Linkable
  74. def linkSubType(shape: AnyShape): Unit
    Definition Classes
    InheritanceChain
  75. def linkTarget: Option[DomainElement]
    Definition Classes
    Linkable
  76. def location(): Option[String]
    Definition Classes
    ExternalSourceElement → AmfElement
  77. val meta: AnyShapeModel
    Definition Classes
    UnionShape → AnyShape → AmfObject
  78. def name: StrField
    Definition Classes
    NamedDomainElement
  79. def nameField: Field
    Attributes
    protected
    Definition Classes
    Shape → NamedDomainElement
  80. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  81. def not: Shape
    Definition Classes
    Shape
  82. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  83. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  84. def or: Seq[Shape]
    Definition Classes
    Shape
  85. def parameterValidator(mediaType: String, exec: BaseExecutionEnvironment): Option[PayloadValidator]
    Definition Classes
    AnyShape
  86. def parameterValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  87. def payloadValidator(mediaType: String, exec: BaseExecutionEnvironment): Option[PayloadValidator]
    Definition Classes
    AnyShape
  88. def payloadValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  89. def payloadValidator(shape: Shape, env: Environment, validationMode: ValidationMode): PlatformPayloadValidator
    Attributes
    protected
    Definition Classes
    JsonSchemaSecrets
  90. val platform: Platform
    Definition Classes
    PlatformSecrets
  91. def position(): Option[LexicalInformation]
    Definition Classes
    AmfElement
  92. def ramlSyntaxKey: String
    Definition Classes
    UnionShape → AnyShape → Shape
  93. def raw: StrField
    Definition Classes
    ExternalSourceElement
  94. def readOnly: BoolField
    Definition Classes
    Shape
  95. val refAst: Option[YPart]
    Definition Classes
    Linkable
  96. val refCtx: Option[ParserContext]
    Definition Classes
    Linkable
  97. val refName: String
    Definition Classes
    Linkable
  98. def referenceId: StrField
    Definition Classes
    ExternalSourceElement
  99. def removeExamples(): Unit
    Definition Classes
    ExemplifiedDomainElement
  100. def resolveUnreferencedLink[T](label: String, annotations: Annotations, unresolved: T, supportsRecursion: Boolean): T
    Definition Classes
    Linkable
  101. def set(field: Field, value: AmfElement, annotations: Annotations): UnionShape.this.type
    Definition Classes
    AmfObject
  102. def set(field: Field, value: AmfElement): UnionShape.this.type
    Definition Classes
    AmfObject
  103. def set(field: Field, values: Seq[String]): UnionShape.this.type
    Definition Classes
    AmfObject
  104. def set(field: Field, value: Float): UnionShape.this.type
    Definition Classes
    AmfObject
  105. def set(field: Field, value: Double): UnionShape.this.type
    Definition Classes
    AmfObject
  106. def set(field: Field, value: Int): UnionShape.this.type
    Definition Classes
    AmfObject
  107. def set(field: Field, value: Boolean): UnionShape.this.type
    Definition Classes
    AmfObject
  108. def set(field: Field, value: String): UnionShape.this.type
    Definition Classes
    AmfObject
  109. def setArray(field: Field, values: Seq[AmfElement], annotations: Annotations): UnionShape.this.type
    Definition Classes
    AmfObject
  110. def setArray(field: Field, values: Seq[AmfElement]): UnionShape.this.type
    Definition Classes
    AmfObject
  111. def setArrayWithoutId(field: Field, values: Seq[AmfElement], annotations: Annotations): UnionShape.this.type
    Definition Classes
    AmfObject
  112. def setArrayWithoutId(field: Field, values: Seq[AmfElement]): UnionShape.this.type
    Definition Classes
    AmfObject
  113. def setDefaultStrValue(entry: YMapEntry): Unit
    Definition Classes
    ShapeHelper
  114. def setWithoutId(field: Field, value: AmfElement, annotations: Annotations): UnionShape.this.type
    Definition Classes
    AmfObject
  115. val shouldLink: Boolean
    Attributes
    protected
    Definition Classes
    Linkable
  116. final def simpleAdoption(parent: String): UnionShape.this.type
    Definition Classes
    AmfObject
  117. val subTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  118. val superTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  119. def supportsRecursion: BoolField
    Definition Classes
    Linkable
  120. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  121. def thenShape: Shape
    Definition Classes
    Shape
  122. def toFutureRef(resolve: (Linkable) ⇒ Unit): Unit
    Definition Classes
    Linkable
  123. def toJsonSchema(exec: BaseExecutionEnvironment = ...): String
    Definition Classes
    AnyShape
  124. def toJsonSchema(element: AnyShape, exec: BaseExecutionEnvironment): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  125. def toRamlDatatype(exec: BaseExecutionEnvironment = ...): String

    Delegates generation of a new RAML Data Type or returns cached one if it was generated before.

    Delegates generation of a new RAML Data Type or returns cached one if it was generated before.

    Definition Classes
    AnyShape
  126. def toRamlDatatype(element: AnyShape, exec: BaseExecutionEnvironment): String

    Delegates generation of a new RAML Data Type or returns cached one if it was generated before.

    Delegates generation of a new RAML Data Type or returns cached one if it was generated before.

    Attributes
    protected
    Definition Classes
    RamlDatatypeSerializer
  127. def trackedExample(trackId: String): Option[Example]
    Definition Classes
    AnyShape
  128. def typeExpression(eh: ErrorHandler): String
    Definition Classes
    ShapeHelpers
  129. def unresolved(refName: String, refAst: YPart, unresolvedSeverity: String)(implicit ctx: ParserContext): DomainElement with Linkable
    Definition Classes
    Linkable
  130. val unresolvedSeverity: String
    Definition Classes
    Linkable
  131. def validate(fragment: PayloadFragment, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  132. def validate(fragment: PayloadFragment, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  133. def validate(fragment: PayloadFragment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  134. def validate(fragment: PayloadFragment, env: Environment, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  135. def validate(payload: String, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  136. def validate(payload: String, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  137. def validate(payload: String): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  138. def validate(payload: String, env: Environment, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  139. def validateParameter(payload: String, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  140. def validateParameter(payload: String, env: Environment = Environment(), exec: BaseExecutionEnvironment = ...): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  141. def values: Seq[DataNode]
    Definition Classes
    Shape
  142. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  143. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  144. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  145. def withAnd(subShapes: Seq[Shape]): UnionShape.this.type
    Definition Classes
    Shape
  146. def withAnyOf(elements: Seq[Shape]): UnionShape.this.type
  147. def withComment(comment: String): UnionShape.this.type
    Definition Classes
    AnyShape
  148. def withCustomDomainProperties(extensions: Seq[DomainExtension]): UnionShape.this.type
    Definition Classes
    DomainElement
  149. def withCustomDomainProperty(extensions: DomainExtension): UnionShape.this.type
    Definition Classes
    DomainElement
  150. def withCustomShapeProperties(properties: Seq[ShapeExtension]): UnionShape.this.type
    Definition Classes
    Shape
  151. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  152. def withCustomShapePropertyDefinitions(propertyDefinitions: Seq[PropertyShape]): UnionShape.this.type
    Definition Classes
    Shape
  153. def withDefault(default: DataNode): UnionShape.this.type
    Definition Classes
    Shape
  154. def withDefaultStr(value: String): UnionShape.this.type
    Definition Classes
    Shape
  155. def withDeprecated(deprecated: Boolean): UnionShape.this.type
    Definition Classes
    Shape
  156. def withDescription(description: String): UnionShape.this.type
    Definition Classes
    Shape
  157. def withDisplayName(name: String): UnionShape.this.type
    Definition Classes
    Shape
  158. def withDocumentation(documentation: CreativeWork): UnionShape.this.type
    Definition Classes
    AnyShape
  159. def withElse(elseShape: Shape): UnionShape.this.type
    Definition Classes
    Shape
  160. def withExample(name: Option[String]): Example
    Definition Classes
    ExemplifiedDomainElement
  161. def withExamples(examples: Seq[Example]): UnionShape.this.type
    Definition Classes
    ExemplifiedDomainElement
  162. def withExtends(extend: Seq[DomainElement]): UnionShape.this.type
    Definition Classes
    DomainElement
  163. def withId(value: String): UnionShape.this.type
    Definition Classes
    AmfObject
  164. def withIf(ifShape: Shape): UnionShape.this.type
    Definition Classes
    Shape
  165. def withInherits(inherits: Seq[Shape]): UnionShape.this.type
    Definition Classes
    Shape
  166. def withLinkLabel(label: String): UnionShape.this.type
    Definition Classes
    Linkable
  167. def withLinkTarget(target: DomainElement): UnionShape.this.type
    Definition Classes
    Linkable
  168. def withName(name: String, a: Annotations): UnionShape.this.type
    Definition Classes
    NamedDomainElement
  169. def withNot(shape: Shape): UnionShape.this.type
    Definition Classes
    Shape
  170. def withOr(subShapes: Seq[Shape]): UnionShape.this.type
    Definition Classes
    Shape
  171. def withReadOnly(readOnly: Boolean): UnionShape.this.type
    Definition Classes
    Shape
  172. def withReference(id: String): UnionShape.this.type
    Definition Classes
    ExternalSourceElement
  173. def withSupportsRecursion(recursive: Boolean): UnionShape.this.type
    Definition Classes
    Linkable
  174. def withThen(thenShape: Shape): UnionShape.this.type
    Definition Classes
    Shape
  175. def withValues(values: Seq[DataNode]): UnionShape.this.type
    Definition Classes
    Shape
  176. def withWriteOnly(writeOnly: Boolean): UnionShape.this.type
    Definition Classes
    Shape
  177. def withXMLSerialization(xmlSerialization: XMLSerializer): UnionShape.this.type
    Definition Classes
    AnyShape
  178. def withXone(subShapes: Seq[Shape]): UnionShape.this.type
    Definition Classes
    Shape
  179. def writeOnly: BoolField
    Definition Classes
    Shape
  180. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
  181. def xone: Seq[Shape]
    Definition Classes
    Shape

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyShape

Inherited from ExemplifiedDomainElement

Inherited from DocumentedElement

Inherited from InheritanceChain

Inherited from ExternalSourceElement

Inherited from RamlDatatypeSerializer

Inherited from JsonSchemaSerializer

Inherited from PlatformSecrets

Inherited from ShapeHelpers

Inherited from JsonSchemaSecrets

Inherited from Shape

Inherited from ShapeHelper

Inherited from NamedDomainElement

Inherited from Linkable

Inherited from DomainElement

Inherited from AmfObject

Inherited from AmfElement

Inherited from AnyRef

Inherited from Any

Ungrouped