com.squareup.leakcanary.HeapDumper Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2015 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;

import java.io.File;

/** Dumps the heap into a file. */
public interface HeapDumper {
  HeapDumper NONE = new HeapDumper() {
    @Override public File dumpHeap() {
      return RETRY_LATER;
    }
  };

  File RETRY_LATER = null;

  /**
   * @return a {@link File} referencing the dumped heap, or {@link #RETRY_LATER} if the heap could
   * not be dumped.
   */
  File dumpHeap();
}