git://git.uio.no / ifi-stolz-refaktor.git / blame
| Commit | Line | Data |
|---|---|---|
| 1b2798f6 EK |
1 | /******************************************************************************* |
| 2 | * Copyright (c) 2000, 2008 IBM Corporation and others. | |
| 3 | * All rights reserved. This program and the accompanying materials | |
| 4 | * are made available under the terms of the Eclipse Public License v1.0 | |
| 5 | * which accompanies this distribution, and is available at | |
| 6 | * http://www.eclipse.org/legal/epl-v10.html | |
| 7 | * | |
| 8 | * Contributors: | |
| 9 | * IBM Corporation - initial API and implementation | |
| 10 | *******************************************************************************/ | |
| 11 | package org.eclipse.jdt.ui.jarpackager; | |
| 12 | ||
| 13 | import org.eclipse.core.runtime.CoreException; | |
| 14 | import org.eclipse.core.runtime.IStatus; | |
| 15 | ||
| 16 | /** | |
| 17 | * Reads the description file of a JAR package data object | |
| 18 | * into such an object. | |
| 19 | * <p> | |
| 20 | * The format is defined by the client who implements the | |
| 21 | * reader/writer pair. | |
| 22 | * </p> | |
| 23 | * | |
| 24 | * @see org.eclipse.jdt.ui.jarpackager.JarPackageData | |
| 25 | * @see org.eclipse.jdt.ui.jarpackager.IJarDescriptionWriter | |
| 26 | * @since 2.0 | |
| 27 | */ | |
| 28 | public interface IJarDescriptionReader { | |
| 29 | ||
| 30 | /** | |
| 31 | * Reads Jar Package description and fills data into | |
| 32 | * the JAR Package data object. | |
| 33 | * <p> | |
| 34 | * It is the client's responsibility to close this reader. | |
| 35 | * </p> | |
| 36 | * | |
| 37 | * @param jarPackageData the object into which data is filled | |
| 38 | * @throws CoreException if read failed, e.g. I/O error during read operation | |
| 39 | */ | |
| 40 | public void read(JarPackageData jarPackageData) throws CoreException; | |
| 41 | ||
| 42 | /** | |
| 43 | * Closes this reader. | |
| 44 | * <p> | |
| 45 | * It is the client's responsibility to close this reader. | |
| 46 | * </p> | |
| 47 | * | |
| 48 | * @throws CoreException if closing fails, e.g. I/O error during close operation | |
| 49 | */ | |
| 50 | public void close() throws CoreException; | |
| 51 | ||
| 52 | /** | |
| 53 | * Returns the status of this reader. | |
| 54 | * If there were any errors, the result is a status object containing | |
| 55 | * individual status objects for each error. | |
| 56 | * If there were no errors, the result is a status object with error code <code>OK</code>. | |
| 57 | * | |
| 58 | * @return the status of this operation | |
| 59 | */ | |
| 60 | public IStatus getStatus(); | |
| 61 | } |