class DocumentIndex extends AnyRef

Metadata document index, maintains information on available metadata files and reports errors against them for things like duplicates or missing meta files. See DocumentScanner for initial generation of the index. Documents are grouped under a controlling typeName to make it easier to validate them later, so cls-meta.xml files are grouped with .cls and fields, fieldSets & sharing reasons are grouped with object-meta.xml files.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DocumentIndex
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DocumentIndex(path: PathLike, logger: IssuesManager, namespace: Option[Name], isGulped: Boolean, ignore: Option[ForceIgnore])

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. def get(typeName: TypeName): List[MetadataDocument]

    Get all documents for specific typename, this is a little more expensive than searching for a specific nature (see above) but also more general.

  10. def get(nature: MetadataNature, typeName: TypeName): List[MetadataDocument]

    Get all documents for specific type of metadata that contribute to a specific typename

  11. def get(nature: MetadataNature): Map[String, List[PathLike]]

    Get all documents for specific type of metadata, beware mutable Map to avoid conversion

  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def getControllingDocuments(nature: MetadataNature): List[MetadataDocument]

    Get the controlling docs for a specific nature.

  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def isVisibleFile(path: PathLike): Boolean
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. val path: PathLike
  21. def remove(document: MetadataDocument): Boolean

    Remove a document from the store.

    Remove a document from the store. Returns true if the document was in the store and removed.

  22. def size: Int
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. def upsert(document: MetadataDocument): Boolean

    Upsert a document.

    Upsert a document. Returns false if document is not visible to the index.

  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped