Type Members

1.  final case class DotName(names: Seq[Name]) extends Product with Serializable

   A qualified name with notional 'dot' separators

2.  final case class EncodedName(name: Name, ext: Option[Name], namespace: Option[Name]) extends Product with Serializable

   A name with optional namespace prefixing & optional type suffix such as foofieldc.

   A name with optional namespace prefixing & optional type suffix such as foofieldc. Only a small set of suffixes are supported. It's not clear what the full list used by Salesforce is. This class is safe to use on non-encoded names which don't contain \_\_, although you can not default the namespace on them.

   Where all of namespace, name and suffix are provided the code will assert on a bad suffix. Where we only have two parts of the name then if the last parts is not a valid suffix the handling will assume the first part is a namespace and the second the name, as in Page.pkg1\_\_TestPage.

   The code deals with a few exception cases where splitting on \_\_ would gives either a wrong name or ext part. For subfields the subfield name is combined with the extension. For supporting SObjects such as MyObject\_\_Feed the 'Feed' is considered an extension in the same way that 'c' would be.

3.  final case class Name(value: String) extends Product with Serializable

   Case insensitive string for symbol names.

   Case insensitive string for symbol names.

   The value of the Name is stored as is but equality and hashing are performed against a normalised lower case value.

   Annotations

   @key("Name")

4.  final case class TypeIdentifier(namespace: Option[Name], typeName: TypeName) extends Product with Serializable

   Identifier for a specific type within an Org.

   Identifier for a specific type within an Org.

   The provided namespace is used to locate a package which qualifies the meaning of the type name. This is useful when the type name may not contain a namespace or it may be visible across package such as with global classes.

5.  final case class TypeName(name: Name, params: Seq[TypeName], outer: Option[TypeName]) extends Product with Serializable

   Representation of a type name with optional type arguments.

   Representation of a type name with optional type arguments.

   The outer value provides an optional enclosing type name to allow for qualifying inner types. The outer may also be used to scope a type to a specific namespace. The mapping between a type name and its toString value is mostly straight forward but for some internally defined types toString will produce better formatted output so it is advised you always use this when displaying a TypeName.

   Annotations

   @key("TypeName")