io.atomicbits.scraml.ramlparser.lookup

CanonicalLookupHelper

case class CanonicalLookupHelper(lookupTable: Map[CanonicalName, NonPrimitiveType] = ..., parsedTypeIndex: Map[UniqueId, ParsedType] = ..., referenceOnlyParsedTypeIndex: Map[UniqueId, ParsedType] = ..., jsonSchemaNativeToAbsoluteIdMap: Map[NativeId, AbsoluteId] = ...) extends Product with Serializable

lookupTable

The canonical lookup map.

parsedTypeIndex

The types that are explicitely declared the in the Raml model's types declaration and those that are implicitely declared inside the resource's parameters (e.g. GET parameters) and body content of responses and replies. Each type declaration is keyed on its native (RAML) id.

referenceOnlyParsedTypeIndex

Like parsedTypeIndex, but the elements in this index will not be used directly to create canonical types later on. This index will only contain the Selection elements of a json-schema object. We need to be able to look up those elements, but we will generate their canonical form through their parent.

jsonSchemaNativeToAbsoluteIdMap

Native references may be used in the RAML definition to refer to json-schema types that have their own json-schema id internally. This map enables us to translate the canonical name that matches the native id to the canonical name that matches the json-schema id.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CanonicalLookupHelper
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CanonicalLookupHelper(lookupTable: Map[CanonicalName, NonPrimitiveType] = ..., parsedTypeIndex: Map[UniqueId, ParsedType] = ..., referenceOnlyParsedTypeIndex: Map[UniqueId, ParsedType] = ..., jsonSchemaNativeToAbsoluteIdMap: Map[NativeId, AbsoluteId] = ...)

    lookupTable

    The canonical lookup map.

    parsedTypeIndex

    The types that are explicitely declared the in the Raml model's types declaration and those that are implicitely declared inside the resource's parameters (e.g. GET parameters) and body content of responses and replies. Each type declaration is keyed on its native (RAML) id.

    referenceOnlyParsedTypeIndex

    Like parsedTypeIndex, but the elements in this index will not be used directly to create canonical types later on. This index will only contain the Selection elements of a json-schema object. We need to be able to look up those elements, but we will generate their canonical form through their parent.

    jsonSchemaNativeToAbsoluteIdMap

    Native references may be used in the RAML definition to refer to json-schema types that have their own json-schema id internally. This map enables us to translate the canonical name that matches the native id to the canonical name that matches the json-schema id.

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. def addCanonicalType(canonicalName: CanonicalName, canonicalType: NonPrimitiveType): CanonicalLookupHelper

  7. def addJsonSchemaNativeToAbsoluteIdTranslation(jsonSchemaNativeId: NativeId, jsonSchemaAbsoluteId: AbsoluteId): CanonicalLookupHelper

  8. def addParsedTypeIndex(id: Id, parsedType: ParsedType, lookupOnly: Boolean = false): CanonicalLookupHelper

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  11. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  12. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  13. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  14. def getParsedTypeWithProperId(id: Id): Option[ParsedType]

  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  16. val jsonSchemaNativeToAbsoluteIdMap: Map[NativeId, AbsoluteId]

    Native references may be used in the RAML definition to refer to json-schema types that have their own json-schema id internally.

    Native references may be used in the RAML definition to refer to json-schema types that have their own json-schema id internally. This map enables us to translate the canonical name that matches the native id to the canonical name that matches the json-schema id.

  17. val lookupTable: Map[CanonicalName, NonPrimitiveType]

    The canonical lookup map.

  18. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  19. final def notify(): Unit

    Definition Classes
    AnyRef

  20. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  21. val parsedTypeIndex: Map[UniqueId, ParsedType]

    The types that are explicitely declared the in the Raml model's types declaration and those that are implicitely declared inside the resource's parameters (e.

    The types that are explicitely declared the in the Raml model's types declaration and those that are implicitely declared inside the resource's parameters (e.g. GET parameters) and body content of responses and replies. Each type declaration is keyed on its native (RAML) id.

  22. val referenceOnlyParsedTypeIndex: Map[UniqueId, ParsedType]

    Like parsedTypeIndex, but the elements in this index will not be used directly to create canonical types later on.

    Like parsedTypeIndex, but the elements in this index will not be used directly to create canonical types later on. This index will only contain the Selection elements of a json-schema object. We need to be able to look up those elements, but we will generate their canonical form through their parent.

  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  24. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped