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

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyShape, ValidatorAware, ExemplifiedDomainElement, DocumentedElement, InheritanceChain, ExternalSourceElement, RamlDatatypeSerializer, JsonSchemaSerializer, PlatformSecrets, ShapeHelpers, JsonSchemaSecrets, Shape, ShapeHelper, NamedDomainElement, Linkable, DomainElement, CustomizableElement, AmfObject, AmfElement, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UnionShape
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyShape
  7. ValidatorAware
  8. ExemplifiedDomainElement
  9. DocumentedElement
  10. InheritanceChain
  11. ExternalSourceElement
  12. RamlDatatypeSerializer
  13. JsonSchemaSerializer
  14. PlatformSecrets
  15. ShapeHelpers
  16. JsonSchemaSecrets
  17. Shape
  18. ShapeHelper
  19. NamedDomainElement
  20. Linkable
  21. DomainElement
  22. CustomizableElement
  23. AmfObject
  24. AmfElement
  25. AnyRef
  26. 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 cloneElement(branch: Map[AmfObject, AmfObject]): AmfObject
    Definition Classes
    AmfObject → AmfElement
  22. def cloneShape(recursionErrorHandler: Option[ErrorHandler], withRecursionBase: Option[String] = None, traversal: ModelTraversalRegistry = ModelTraversalRegistry(), cloneExamples: Boolean = false): UnionShape.this.type
    Definition Classes
    ShapeHelpers
  23. def collectCustomShapePropertyDefinitions(onlyInherited: Boolean, traversed: Set[String]): Seq[FacetsMap]
    Definition Classes
    Shape
  24. def comment: StrField
    Definition Classes
    AnyShape
  25. 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
  26. def computeSubtypesClosure(): Seq[Shape]
    Attributes
    protected
    Definition Classes
    InheritanceChain
  27. def copyAnyShape(fields: Fields = fields, annotations: Annotations = annotations): AnyShape
    Definition Classes
    AnyShape
  28. def copyElement(a: Annotations): Linkable with DomainElement
    Definition Classes
    Linkable
  29. def copyElement(): Linkable with DomainElement
    Definition Classes
    Linkable
  30. def copyFields(recursionErrorHandler: Option[ErrorHandler], cloned: Shape, recursionBase: Option[String], traversal: ModelTraversalRegistry): Unit
    Attributes
    protected
    Definition Classes
    Shape
  31. def copyShape(): UnionShape.this.type
    Definition Classes
    AnyShape → Shape
  32. def copyShape(a: Annotations): UnionShape.this.type
    Definition Classes
    Shape
  33. def customDomainProperties: Seq[DomainExtension]
    Definition Classes
    DomainElement → CustomizableElement
  34. def customShapeProperties: Seq[ShapeExtension]
    Definition Classes
    Shape
  35. def customShapePropertyDefinitions: Seq[PropertyShape]
    Definition Classes
    Shape
  36. def default: DataNode
    Definition Classes
    Shape
  37. def defaultString: StrField
    Definition Classes
    Shape
  38. def deprecated: BoolField
    Definition Classes
    Shape
  39. def description: StrField
    Definition Classes
    Shape
  40. def displayName: StrField
    Definition Classes
    Shape
  41. def documentation: CreativeWork
    Definition Classes
    AnyShape
  42. def documentations: Seq[CreativeWork]
    Definition Classes
    AnyShape → DocumentedElement
  43. def effectiveInherits: Seq[Shape]
    Definition Classes
    Shape
  44. def effectiveLinkTarget(links: Seq[String]): DomainElement
    Definition Classes
    Linkable
  45. def effectiveStructuralShapes: Seq[Shape]
    Definition Classes
    InheritanceChain
  46. def elseShape: Shape
    Definition Classes
    Shape
  47. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  48. def examples: Seq[Example]
    Definition Classes
    ExemplifiedDomainElement
  49. def extend: Seq[DomainElement]
    Definition Classes
    DomainElement
  50. def externalSourceID: Option[String]
    Definition Classes
    ShapeHelpers
  51. val fields: Fields
    Definition Classes
    UnionShape → AnyShape → AmfObject
  52. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  53. def fromExternalSource: Boolean
    Definition Classes
    ShapeHelpers
  54. def fromLocal(): Boolean
    Definition Classes
    AmfElement
  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 isAnyType: Boolean
    Definition Classes
    AnyShape
  65. 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
  66. def isExternalLink: BoolField
    Definition Classes
    DomainElement
  67. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  68. def isLink: Boolean
    Definition Classes
    Linkable
  69. def isLinkToSource: Boolean
    Definition Classes
    ExternalSourceElement
  70. def isTrackedBy(trackId: String): Boolean
    Definition Classes
    AmfElement
  71. val isUnresolved: Boolean
    Definition Classes
    Linkable
  72. def link[T](label: String, annotations: Annotations): T
    Definition Classes
    Linkable
  73. val linkAnnotations: Option[Annotations]
    Definition Classes
    Linkable
  74. def linkCopy(): AnyShape
    Definition Classes
    UnionShape → AnyShape → Linkable
  75. def linkLabel: StrField
    Definition Classes
    Linkable
  76. def linkSubType(shape: AnyShape): Unit
    Definition Classes
    InheritanceChain
  77. def linkTarget: Option[DomainElement]
    Definition Classes
    Linkable
  78. def location(): Option[String]
    Definition Classes
    ExternalSourceElement → AmfElement
  79. val meta: AnyShapeModel
    Definition Classes
    UnionShape → AnyShape → AmfObject
  80. def name: StrField
    Definition Classes
    NamedDomainElement
  81. def nameField: Field
    Attributes
    protected
    Definition Classes
    Shape → NamedDomainElement
  82. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  83. def not: Shape
    Definition Classes
    Shape
  84. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  85. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  86. def or: Seq[Shape]
    Definition Classes
    Shape
  87. def parameterValidator(mediaType: String, exec: BaseExecutionEnvironment): Option[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
  88. def parameterValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
  89. def payloadValidator(mediaType: String, exec: BaseExecutionEnvironment): Option[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
  90. def payloadValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape → ValidatorAware
  91. def payloadValidator(shape: Shape, env: Environment, validationMode: ValidationMode): PlatformPayloadValidator
    Attributes
    protected
    Definition Classes
    JsonSchemaSecrets
  92. val platform: Platform
    Definition Classes
    PlatformSecrets
  93. def position(): Option[LexicalInformation]
    Definition Classes
    AmfElement
  94. def ramlSyntaxKey: String
    Definition Classes
    UnionShape → AnyShape → Shape
  95. def raw: StrField
    Definition Classes
    ExternalSourceElement
  96. def readOnly: BoolField
    Definition Classes
    Shape
  97. val refAst: Option[YPart]
    Definition Classes
    Linkable
  98. val refCtx: Option[ParserContext]
    Definition Classes
    Linkable
  99. val refName: String
    Definition Classes
    Linkable
  100. def referenceId: StrField
    Definition Classes
    ExternalSourceElement
  101. def removeExamples(): Unit
    Definition Classes
    ExemplifiedDomainElement
  102. def resolveUnreferencedLink[T](label: String, annotations: Annotations, unresolved: T, supportsRecursion: Boolean): T
    Definition Classes
    Linkable
  103. def set(field: Field, value: AmfElement, annotations: Annotations): UnionShape.this.type
    Definition Classes
    AmfObject
  104. def set(field: Field, value: AmfElement): UnionShape.this.type
    Definition Classes
    AmfObject
  105. def set(field: Field, values: Seq[String]): UnionShape.this.type
    Definition Classes
    AmfObject
  106. def set(field: Field, value: Float): UnionShape.this.type
    Definition Classes
    AmfObject
  107. def set(field: Field, value: Double): UnionShape.this.type
    Definition Classes
    AmfObject
  108. def set(field: Field, value: Int): UnionShape.this.type
    Definition Classes
    AmfObject
  109. def set(field: Field, value: Boolean): UnionShape.this.type
    Definition Classes
    AmfObject
  110. def set(field: Field, value: String, annotations: Annotations): UnionShape.this.type
    Definition Classes
    AmfObject
  111. def set(field: Field, value: String): UnionShape.this.type
    Definition Classes
    AmfObject
  112. def setArray(field: Field, values: Seq[AmfElement], annotations: Annotations): UnionShape.this.type
    Definition Classes
    AmfObject
  113. def setArray(field: Field, values: Seq[AmfElement]): UnionShape.this.type
    Definition Classes
    AmfObject
  114. def setArrayWithoutId(field: Field, values: Seq[AmfElement], annotations: Annotations): UnionShape.this.type
    Definition Classes
    AmfObject
  115. def setArrayWithoutId(field: Field, values: Seq[AmfElement]): UnionShape.this.type
    Definition Classes
    AmfObject
  116. def setDefaultStrValue(entry: YMapEntry): Unit
    Definition Classes
    ShapeHelper
  117. def setWithoutId(field: Field, value: AmfElement, annotations: Annotations): UnionShape.this.type
    Definition Classes
    AmfObject
  118. val shouldLink: Boolean
    Attributes
    protected
    Definition Classes
    Linkable
  119. final def simpleAdoption(parent: String): UnionShape.this.type
    Definition Classes
    AmfObject
  120. val subTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  121. val superTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  122. def supportsRecursion: BoolField
    Definition Classes
    Linkable
  123. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  124. def thenShape: Shape
    Definition Classes
    Shape
  125. def toFutureRef(resolve: (Linkable) ⇒ Unit): Unit
    Definition Classes
    Linkable
  126. def toJsonSchema(exec: BaseExecutionEnvironment = ...): String
    Definition Classes
    AnyShape
  127. def toJsonSchema(element: AnyShape, exec: BaseExecutionEnvironment): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  128. 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
  129. 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
  130. def trackedExample(trackId: String): Option[Example]
    Definition Classes
    AnyShape
  131. def typeExpression: Option[String]
    Definition Classes
    ShapeHelpers
  132. def unresolved(refName: String, refAst: YPart, unresolvedSeverity: String)(implicit ctx: ParserContext): DomainElement with Linkable
    Definition Classes
    Linkable
  133. val unresolvedSeverity: String
    Definition Classes
    Linkable
  134. def validate(fragment: PayloadFragment, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  135. def validate(fragment: PayloadFragment, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  136. def validate(fragment: PayloadFragment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  137. def validate(fragment: PayloadFragment, env: Environment, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  138. def validate(payload: String, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  139. def validate(payload: String, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  140. def validate(payload: String): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  141. def validate(payload: String, env: Environment, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  142. def validateParameter(payload: String, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  143. def validateParameter(payload: String, env: Environment = Environment(), exec: BaseExecutionEnvironment = ...): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  144. def values: Seq[DataNode]
    Definition Classes
    Shape
  145. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  146. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  147. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  148. def withAnd(subShapes: Seq[Shape]): UnionShape.this.type
    Definition Classes
    Shape
  149. def withAnyOf(elements: Seq[Shape], annotations: Annotations = Annotations()): UnionShape.this.type
  150. def withComment(comment: String): UnionShape.this.type
    Definition Classes
    AnyShape
  151. def withCustomDomainProperties(extensions: Seq[DomainExtension]): UnionShape.this.type
    Definition Classes
    DomainElement → CustomizableElement
  152. def withCustomDomainProperty(extensions: DomainExtension): UnionShape.this.type
    Definition Classes
    DomainElement → CustomizableElement
  153. def withCustomShapeProperties(properties: Seq[ShapeExtension]): UnionShape.this.type
    Definition Classes
    Shape
  154. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  155. def withCustomShapePropertyDefinitions(propertyDefinitions: Seq[PropertyShape]): UnionShape.this.type
    Definition Classes
    Shape
  156. def withDefault(default: DataNode, annotations: Annotations): UnionShape.this.type
    Definition Classes
    Shape
  157. def withDefaultStr(value: String): UnionShape.this.type
    Definition Classes
    Shape
  158. def withDeprecated(deprecated: Boolean): UnionShape.this.type
    Definition Classes
    Shape
  159. def withDescription(description: String): UnionShape.this.type
    Definition Classes
    Shape
  160. def withDisplayName(name: String): UnionShape.this.type
    Definition Classes
    Shape
  161. def withDocumentation(documentation: CreativeWork): UnionShape.this.type
    Definition Classes
    AnyShape
  162. def withElse(elseShape: Shape): UnionShape.this.type
    Definition Classes
    Shape
  163. def withExample(name: Option[String]): Example
    Definition Classes
    ExemplifiedDomainElement
  164. def withExamples(examples: Seq[Example], annotations: Annotations = Annotations()): UnionShape.this.type
    Definition Classes
    ExemplifiedDomainElement
  165. def withExtends(extend: Seq[DomainElement]): UnionShape.this.type
    Definition Classes
    DomainElement
  166. def withId(value: String): UnionShape.this.type
    Definition Classes
    AmfObject
  167. def withIf(ifShape: Shape): UnionShape.this.type
    Definition Classes
    Shape
  168. def withInherits(inherits: Seq[Shape]): UnionShape.this.type
    Definition Classes
    Shape
  169. def withIsExternalLink(isReference: Boolean): UnionShape.this.type
    Definition Classes
    DomainElement
  170. def withLinkLabel(label: String, annotations: Annotations): UnionShape.this.type
    Definition Classes
    Linkable
  171. def withLinkTarget(target: DomainElement): UnionShape.this.type
    Definition Classes
    Linkable
  172. def withName(nameNode: ScalarNode): UnionShape.this.type
    Definition Classes
    NamedDomainElement
  173. def withName(name: String, a: Annotations): UnionShape.this.type
    Definition Classes
    NamedDomainElement
  174. def withName(node: YNode): UnionShape.this.type
    Definition Classes
    NamedDomainElement
  175. def withNot(shape: Shape): UnionShape.this.type
    Definition Classes
    Shape
  176. def withOr(subShapes: Seq[Shape]): UnionShape.this.type
    Definition Classes
    Shape
  177. def withReadOnly(readOnly: Boolean): UnionShape.this.type
    Definition Classes
    Shape
  178. def withReference(id: String): UnionShape.this.type
    Definition Classes
    ExternalSourceElement
  179. def withSupportsRecursion(recursive: Boolean): UnionShape.this.type
    Definition Classes
    Linkable
  180. def withSynthesizeName(name: String): UnionShape.this.type
    Definition Classes
    NamedDomainElement
  181. def withThen(thenShape: Shape): UnionShape.this.type
    Definition Classes
    Shape
  182. def withValues(values: Seq[DataNode]): UnionShape.this.type
    Definition Classes
    Shape
  183. def withWriteOnly(writeOnly: Boolean): UnionShape.this.type
    Definition Classes
    Shape
  184. def withXMLSerialization(xmlSerialization: XMLSerializer): UnionShape.this.type
    Definition Classes
    AnyShape
  185. def withXone(subShapes: Seq[Shape]): UnionShape.this.type
    Definition Classes
    Shape
  186. def writeOnly: BoolField
    Definition Classes
    Shape
  187. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
  188. def xone: Seq[Shape]
    Definition Classes
    Shape

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyShape

Inherited from ValidatorAware

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 CustomizableElement

Inherited from AmfObject

Inherited from AmfElement

Inherited from AnyRef

Inherited from Any

Ungrouped