leakcanary-android-instrumentation/src/main/java/com/squareup/leakcanary/InstrumentationLeakResults.kt

/*
 * Copyright (C) 2018 Square, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.squareup.leakcanary

/**
 * @param detectedLeaks Proper leaks found during instrumentation tests.
 *
 * @param excludedLeaks Excluded leaks found during instrumentation tests,
 *   based on [RefWatcherBuilder.excludedRefs]
 *
 * @param failures Leak analysis failures that happened when we tried to detect leaks.
 */
class InstrumentationLeakResults(
  val detectedLeaks: List<Result>,
  val excludedLeaks: List<Result>,
  val failures: List<Result>
) {

  class Result(
    val heapDump: HeapDump,
    val analysisResult: AnalysisResult
  )

  companion object {
    val NONE = InstrumentationLeakResults(emptyList(), emptyList(), emptyList())
  }
}