class IssueLogger extends IssuesCollection

Issue management class that holds Issues for each metadata file and tracks when they change to allow clients to be more selective when pulling issues.

Note: To support virtual filesystem testing then we need to have *Internal methods that pass a PathLike, the public API methods use strings for simplicity.

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

Instance Constructors

  1. new IssueLogger(externalPathFilter: Option[(PathLike) => Boolean] = None)

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(issue: Issue): Unit
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clear(): Unit
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. val externalPathFilter: Option[(PathLike) => Boolean]
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  12. def getDiagnostics(path: PathLike): List[Diagnostic]
  13. def hasErrors: Boolean
  14. def hasUpdatedIssues(): Array[String]

    Array of metadata file paths whose issues have changed since they were last retrieved from this collection.

    Array of metadata file paths whose issues have changed since they were last retrieved from this collection.

    Definition Classes
    IssueLogger → IssuesCollection
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  16. def ignoreUpdatedIssues(path: String): Unit

    Reset the issue update handling for a metadata file.

    Reset the issue update handling for a metadata file. This will cause the file not to be returned from the next call to hasUpdatedIssues() unless new issues are reported.

    Definition Classes
    IssueLogger → IssuesCollection
  17. def ignoreUpdatedIssuesInternal(path: PathLike): Unit
  18. def isEmpty: Boolean
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def issues: ArraySeq[Issue]

    Get all issues as an ArraySeq, compatible with CatchingLogger.issues

  21. def issuesForFile(path: String): Array[io.github.apexdevtools.api.Issue]

    Array of current Issues for the metadata file path.

    Array of current Issues for the metadata file path. Returns an empty array if there are none. Resets the updated issues tracking when called.

    Definition Classes
    IssueLogger → IssuesCollection
  22. def issuesForFileInternal(path: PathLike): Seq[Issue]
  23. def issuesForFileLocation(path: String, location: IssueLocation): Array[io.github.apexdevtools.api.Issue]

    This is specialised accessor to aid PMD integration.

    This is specialised accessor to aid PMD integration.

    Definition Classes
    IssueLogger → IssuesCollection
  24. def issuesForFileLocationInternal(path: PathLike, location: IssueLocation): Array[io.github.apexdevtools.api.Issue]
  25. def issuesForFiles(paths: Array[String], includeWarnings: Boolean, maxIssuesPerFile: Int): Array[io.github.apexdevtools.api.Issue]

    Array of current Issues for multiple metadata files.

    Array of current Issues for multiple metadata files. If paths is empty or null then this will return issues for all metadata files which have them. When includeWarnings is true, issues of any category will be returned otherwise only errors will be returned. The argument maxErrorsPerFile limits the number of Issues returned to the first 'n' on each file, if it is <1 all Issues will be returned for each metadata file. Resets the updated issues tracking when called for all files processed.

    Definition Classes
    IssueLogger → IssuesCollection
  26. def issuesForFilesInternal(paths: Array[PathLike], includeWarnings: Boolean = true, maxIssuesPerFile: Int = 0): Seq[Issue]
  27. def log(issue: Issue): Unit
  28. def logAll(issues: ArraySeq[Issue]): Unit
  29. def logAndGet[T](andIssues: IssuesAnd[T]): T
  30. def logError(path: PathLike, location: Location, message: String): Unit
  31. def logWarning(path: PathLike, location: Location, message: String): Unit
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. def nonEmpty: Boolean
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  36. def pop(path: PathLike): List[Issue]
  37. def push(path: PathLike, issues: List[Issue]): Unit
  38. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  39. def toString(): String
    Definition Classes
    AnyRef → Any
  40. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from IssuesCollection

Inherited from AnyRef

Inherited from Any

Ungrouped