class AnyShape extends Shape with JsonSchemaSecrets with ShapeHelpers with JsonSchemaSerializer with RamlDatatypeSerializer with ExternalSourceElement with InheritanceChain with DocumentedElement with ExemplifiedDomainElement with ValidatorAware

Linear Supertypes
ValidatorAware, ExemplifiedDomainElement, DocumentedElement, InheritanceChain, ExternalSourceElement, RamlDatatypeSerializer, JsonSchemaSerializer, PlatformSecrets, ShapeHelpers, JsonSchemaSecrets, Shape, ShapeHelper, NamedDomainElement, Linkable, DomainElement, CustomizableElement, AmfObject, AmfElement, AnyRef, Any
Known Subclasses
ArrayShape, DataArrangementShape, FileShape, MatrixShape, NilShape, NodeShape, ScalarShape, SchemaShape, TupleShape, UnionShape, UnresolvedShape
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AnyShape
  2. ValidatorAware
  3. ExemplifiedDomainElement
  4. DocumentedElement
  5. InheritanceChain
  6. ExternalSourceElement
  7. RamlDatatypeSerializer
  8. JsonSchemaSerializer
  9. PlatformSecrets
  10. ShapeHelpers
  11. JsonSchemaSecrets
  12. Shape
  13. ShapeHelper
  14. NamedDomainElement
  15. Linkable
  16. DomainElement
  17. CustomizableElement
  18. AmfObject
  19. AmfElement
  20. AnyRef
  21. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AnyShape(fields: Fields, annotations: 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): AnyShape.this.type
    Definition Classes
    AmfObject
  5. def add(other: Annotations): AnyShape.this.type
    Definition Classes
    AmfElement
  6. def add(annotation: Annotation): AnyShape.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]): AnyShape.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
    AnyShape → AmfElement
  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. def buildFixPoint(id: Option[String], name: String, link: Linkable, recursionErrorHandler: Option[ErrorHandler]): RecursiveShape
    Attributes
    protected
    Definition Classes
    ShapeHelpers
  15. def buildJsonSchema(options: ShapeRenderOptions = ShapeRenderOptions(), exec: BaseExecutionEnvironment = ...): String
  16. def buildRamlDatatype(exec: BaseExecutionEnvironment = ...): String

    Generates a new RAML Data Type.

  17. 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
    AnyShape → Linkable
  18. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  19. def cloneAllExamples(cloned: Shape, s: Shape): Unit
    Definition Classes
    ShapeHelpers
  20. def cloneElement(branch: Map[AmfObject, AmfObject]): AmfObject
    Definition Classes
    AmfObject → AmfElement
  21. def cloneShape(recursionErrorHandler: Option[ErrorHandler], withRecursionBase: Option[String] = None, traversal: ModelTraversalRegistry = ModelTraversalRegistry(), cloneExamples: Boolean = false): AnyShape.this.type
    Definition Classes
    ShapeHelpers
  22. def collectCustomShapePropertyDefinitions(onlyInherited: Boolean, traversed: Set[String]): Seq[FacetsMap]
    Definition Classes
    Shape
  23. def comment: StrField
  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
    AnyShape → AmfObject
  25. def computeSubtypesClosure(): Seq[Shape]
    Attributes
    protected
    Definition Classes
    InheritanceChain
  26. def copyAnyShape(fields: Fields = fields, annotations: Annotations = annotations): 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(): AnyShape.this.type
    Definition Classes
    AnyShape → Shape
  31. def copyShape(a: Annotations): AnyShape.this.type
    Definition Classes
    Shape
  32. def customDomainProperties: Seq[DomainExtension]
    Definition Classes
    DomainElement → CustomizableElement
  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
  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 equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  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
    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. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  60. val id: String
    Definition Classes
    AmfObject
  61. def ifShape: Shape
    Definition Classes
    Shape
  62. val inheritedIds: Seq[String]
    Definition Classes
    InheritanceChain
  63. def inherits: Seq[Shape]
    Definition Classes
    Shape
  64. def inlined: Boolean
  65. def isAnyType: Boolean
  66. 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

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

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

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

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