blob: 74d5dc1421512ac73c8d7db3467ddb962a17f6c1 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2002, 2005 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM - Initial API and implementation
*******************************************************************************/
package org.eclipse.core.tools.metadata;
import java.io.File;
/**
* A dumper is an object that knows how to process a given kind of file,
* translating it to a human-readable form.
*/
public interface IDumper {
/**
* Reads a given file and produces a dump object. Any exception that
* may occur during file processing must be caught and stored as
* failure reason in the IDump object returned.
*
* @param file the file to be dumped
* @return a dump object representing the contents of the file dumped
*/
IDump dump(File file);
}