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, 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. AmfObject
  18. AmfElement
  19. AnyRef
  20. 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 cloneShape(recursionErrorHandler: Option[ErrorHandler], withRecursionBase: Option[String] = None, traversal: ModelTraversalRegistry = ModelTraversalRegistry(), cloneExamples: Boolean = false): AnyShape.this.type
    Definition Classes
    ShapeHelpers
  21. def collectCustomShapePropertyDefinitions(onlyInherited: Boolean, traversed: Set[String]): Seq[FacetsMap]
    Definition Classes
    Shape
  22. def comment: StrField
  23. 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
  24. def computeSubtypesClosure(): Seq[Shape]
    Attributes
    protected
    Definition Classes
    InheritanceChain
  25. def copyAnyShape(fields: Fields = fields, annotations: Annotations = annotations): AnyShape
  26. def copyElement(a: Annotations): Linkable with DomainElement
    Definition Classes
    Linkable
  27. def copyElement(): Linkable with DomainElement
    Definition Classes
    Linkable
  28. def copyFields(recursionErrorHandler: Option[ErrorHandler], cloned: Shape, recursionBase: Option[String], traversal: ModelTraversalRegistry): Unit
    Attributes
    protected
    Definition Classes
    Shape
  29. def copyShape(): AnyShape.this.type
    Definition Classes
    AnyShape → Shape
  30. def copyShape(a: Annotations): AnyShape.this.type
    Definition Classes
    Shape
  31. def customDomainProperties: Seq[DomainExtension]
    Definition Classes
    DomainElement
  32. def customShapeProperties: Seq[ShapeExtension]
    Definition Classes
    Shape
  33. def customShapePropertyDefinitions: Seq[PropertyShape]
    Definition Classes
    Shape
  34. def default: DataNode
    Definition Classes
    Shape
  35. def defaultString: StrField
    Definition Classes
    Shape
  36. def deprecated: BoolField
    Definition Classes
    Shape
  37. def description: StrField
    Definition Classes
    Shape
  38. def displayName: StrField
    Definition Classes
    Shape
  39. def documentation: CreativeWork
  40. def documentations: Seq[CreativeWork]
    Definition Classes
    AnyShape → DocumentedElement
  41. def effectiveInherits: Seq[Shape]
    Definition Classes
    Shape
  42. def effectiveLinkTarget(links: Seq[String]): DomainElement
    Definition Classes
    Linkable
  43. def effectiveStructuralShapes: Seq[Shape]
    Definition Classes
    InheritanceChain
  44. def elseShape: Shape
    Definition Classes
    Shape
  45. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  46. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  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
    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 generateJsonSchema(element: AnyShape, options: ShapeRenderOptions = ShapeRenderOptions(), exec: BaseExecutionEnvironment): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  55. 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
  56. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  57. lazy val graph: Graph
    Definition Classes
    DomainElement
  58. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  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
  64. def isAnyType: Boolean
  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

  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
    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. def meta: AnyShapeModel
    Definition Classes
    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
    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): AnyShape.this.type
    Definition Classes
    AmfObject
  104. def set(field: Field, value: AmfElement): AnyShape.this.type
    Definition Classes
    AmfObject
  105. def set(field: Field, values: Seq[String]): AnyShape.this.type
    Definition Classes
    AmfObject
  106. def set(field: Field, value: Float): AnyShape.this.type
    Definition Classes
    AmfObject
  107. def set(field: Field, value: Double): AnyShape.this.type
    Definition Classes
    AmfObject
  108. def set(field: Field, value: Int): AnyShape.this.type
    Definition Classes
    AmfObject
  109. def set(field: Field, value: Boolean): AnyShape.this.type
    Definition Classes
    AmfObject
  110. def set(field: Field, value: String): AnyShape.this.type
    Definition Classes
    AmfObject
  111. def setArray(field: Field, values: Seq[AmfElement], annotations: Annotations): AnyShape.this.type
    Definition Classes
    AmfObject
  112. def setArray(field: Field, values: Seq[AmfElement]): AnyShape.this.type
    Definition Classes
    AmfObject
  113. def setArrayWithoutId(field: Field, values: Seq[AmfElement], annotations: Annotations): AnyShape.this.type
    Definition Classes
    AmfObject
  114. def setArrayWithoutId(field: Field, values: Seq[AmfElement]): AnyShape.this.type
    Definition Classes
    AmfObject
  115. def setDefaultStrValue(entry: YMapEntry): Unit
    Definition Classes
    ShapeHelper
  116. def setWithoutId(field: Field, value: AmfElement, annotations: Annotations): AnyShape.this.type
    Definition Classes
    AmfObject
  117. val shouldLink: Boolean
    Attributes
    protected
    Definition Classes
    Linkable
  118. final def simpleAdoption(parent: String): AnyShape.this.type
    Definition Classes
    AmfObject
  119. val subTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  120. val superTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  121. def supportsRecursion: BoolField
    Definition Classes
    Linkable
  122. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  123. def thenShape: Shape
    Definition Classes
    Shape
  124. def toFutureRef(resolve: (Linkable) ⇒ Unit): Unit
    Definition Classes
    Linkable
  125. def toJsonSchema(exec: BaseExecutionEnvironment = ...): String
  126. def toJsonSchema(element: AnyShape, exec: BaseExecutionEnvironment): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  127. def toRamlDatatype(exec: BaseExecutionEnvironment = ...): String

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

  128. 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
  129. def toString(): String
    Definition Classes
    AnyRef → Any
  130. def trackedExample(trackId: String): Option[Example]
  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]
  135. def validate(fragment: PayloadFragment, env: Environment): Future[AMFValidationReport]
  136. def validate(fragment: PayloadFragment): Future[AMFValidationReport]
  137. def validate(fragment: PayloadFragment, env: Environment, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
  138. def validate(payload: String, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
  139. def validate(payload: String, env: Environment): Future[AMFValidationReport]
  140. def validate(payload: String): Future[AMFValidationReport]
  141. def validate(payload: String, env: Environment, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
  142. def validateParameter(payload: String, exec: BaseExecutionEnvironment): Future[AMFValidationReport]
  143. def validateParameter(payload: String, env: Environment = Environment(), exec: BaseExecutionEnvironment = ...): Future[AMFValidationReport]
  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]): AnyShape.this.type
    Definition Classes
    Shape
  149. def withComment(comment: String): AnyShape.this.type
  150. def withCustomDomainProperties(extensions: Seq[DomainExtension]): AnyShape.this.type
    Definition Classes
    DomainElement
  151. def withCustomDomainProperty(extensions: DomainExtension): AnyShape.this.type
    Definition Classes
    DomainElement
  152. def withCustomShapeProperties(properties: Seq[ShapeExtension]): AnyShape.this.type
    Definition Classes
    Shape
  153. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  154. def withCustomShapePropertyDefinitions(propertyDefinitions: Seq[PropertyShape]): AnyShape.this.type
    Definition Classes
    Shape
  155. def withDefault(default: DataNode): AnyShape.this.type
    Definition Classes
    Shape
  156. def withDefaultStr(value: String): AnyShape.this.type
    Definition Classes
    Shape
  157. def withDeprecated(deprecated: Boolean): AnyShape.this.type
    Definition Classes
    Shape
  158. def withDescription(description: String): AnyShape.this.type
    Definition Classes
    Shape
  159. def withDisplayName(name: String): AnyShape.this.type
    Definition Classes
    Shape
  160. def withDocumentation(documentation: CreativeWork): AnyShape.this.type
  161. def withElse(elseShape: Shape): AnyShape.this.type
    Definition Classes
    Shape
  162. def withExample(name: Option[String]): Example
    Definition Classes
    ExemplifiedDomainElement
  163. def withExamples(examples: Seq[Example]): AnyShape.this.type
    Definition Classes
    ExemplifiedDomainElement
  164. def withExtends(extend: Seq[DomainElement]): AnyShape.this.type
    Definition Classes
    DomainElement
  165. def withId(value: String): AnyShape.this.type
    Definition Classes
    AmfObject
  166. def withIf(ifShape: Shape): AnyShape.this.type
    Definition Classes
    Shape
  167. def withInherits(inherits: Seq[Shape]): AnyShape.this.type
    Definition Classes
    Shape
  168. def withIsExternalLink(isReference: Boolean): AnyShape.this.type
    Definition Classes
    DomainElement
  169. def withLinkLabel(label: String): AnyShape.this.type
    Definition Classes
    Linkable
  170. def withLinkTarget(target: DomainElement): AnyShape.this.type
    Definition Classes
    Linkable
  171. def withName(name: String, a: Annotations): AnyShape.this.type
    Definition Classes
    NamedDomainElement
  172. def withNot(shape: Shape): AnyShape.this.type
    Definition Classes
    Shape
  173. def withOr(subShapes: Seq[Shape]): AnyShape.this.type
    Definition Classes
    Shape
  174. def withReadOnly(readOnly: Boolean): AnyShape.this.type
    Definition Classes
    Shape
  175. def withReference(id: String): AnyShape.this.type
    Definition Classes
    ExternalSourceElement
  176. def withSupportsRecursion(recursive: Boolean): AnyShape.this.type
    Definition Classes
    Linkable
  177. def withThen(thenShape: Shape): AnyShape.this.type
    Definition Classes
    Shape
  178. def withValues(values: Seq[DataNode]): AnyShape.this.type
    Definition Classes
    Shape
  179. def withWriteOnly(writeOnly: Boolean): AnyShape.this.type
    Definition Classes
    Shape
  180. def withXMLSerialization(xmlSerialization: XMLSerializer): AnyShape.this.type
  181. def withXone(subShapes: Seq[Shape]): AnyShape.this.type
    Definition Classes
    Shape
  182. def writeOnly: BoolField
    Definition Classes
    Shape
  183. def xmlSerialization: XMLSerializer
  184. 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 AmfObject

Inherited from AmfElement

Inherited from AnyRef

Inherited from Any

Ungrouped