final class DocumentIndex extends AnyRef
Metadata document index, maintains information on available metadata within a project/package.
Duplicate detection is based on the relevant MetadataDocumentType(s) being able to generate an accurate TypeName for the metadata. Where a document defined a unique type duplicates are reported as errors and then ignored.
During an upsert/deletion of new types the index will also need to be updated so that it maintains an accurate view of the metadata files being used.
- Alphabetic
- By Inheritance
- DocumentIndex
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new DocumentIndex(namespace: Option[Name], path: PathLike, ignore: Option[ForceIgnore], collection: MetadataCollection)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def add(logger: IssueLogger, document: MetadataDocument): Unit
Add a new document, for non-partial documents this will replace any existing document in the store that provides the same type.
Add a new document, for non-partial documents this will replace any existing document in the store that provides the same type. Duplicate detection is left to the caller. For partial types, the document will always be added to the store if not already present.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def get(typeName: TypeName): Set[MetadataDocument]
Get all documents that contribute to a type
- def get(nature: MetadataNature, typeName: TypeName): Set[MetadataDocument]
Get all documents of some nature that contribute to a type
- def get(nature: MetadataNature): Iterator[MetadataDocument]
Get documents of some nature.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isVisibleFile(path: PathLike): Boolean
Check a file path would be included in index.
- val namespace: Option[Name]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val path: PathLike
- def remove(document: MetadataDocument): Boolean
Remove a document, does not error if the document is not in the index.
Remove a document, does not error if the document is not in the index. Returns true if the document was removed.
- val size: Int
Number of documents.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def upsert(logger: IssueLogger, document: MetadataDocument): Boolean
Upsert a document.
Upsert a document. Document defining new or existing types return true, if the document would create a duplicate type it is not added to the store and false is returned.
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()