Copyright (c) 2004, 2013 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 Corporation - initial API and implementation
/*******************************************************************************
 * Copyright (c) 2004, 2013 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 Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.osgi.storage.bundlefile;

import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import org.eclipse.osgi.storage.StorageUtil;

A BundleEntry represents one entry of a BundleFile.

Clients may extend this class.

/**
 * A BundleEntry represents one entry of a BundleFile.
 * <p>
 * Clients may extend this class.
 * </p>
 */
public abstract class BundleEntry {
	protected static final int BUF_SIZE = 8 * 1024;

	
Return an InputStream for the entry.
Throws:
IOException – If an error occurs reading the bundle.
Returns:
InputStream for the entry./**
	 * Return an InputStream for the entry.
	 *
	 * @return InputStream for the entry.
	 * @throws java.io.IOException If an error occurs reading the bundle.
	 */
	public abstract InputStream getInputStream() throws IOException;

	
Return the size of the entry (uncompressed).
Returns:
size of entry./**
	 * Return the size of the entry (uncompressed).
	 *
	 * @return size of entry.
	 */
	public abstract long getSize();

	
Return the name of the entry.
Returns:
name of entry./**
	 * Return the name of the entry.
	 *
	 * @return name of entry.
	 */
	public abstract String getName();

	
Get the modification time for this BundleEntry.
If the modification time has not been set,
this method will return -1.
Returns:
last modification time./**
	 * Get the modification time for this BundleEntry.
	 * <p>If the modification time has not been set,
	 * this method will return <tt>-1</tt>.
	 *
	 * @return last modification time.
	 */
	public abstract long getTime();

	
Get a URL to the bundle entry that uses a common protocol (i.e. file:
jar: or http: etc.).  
Returns:
a URL to the bundle entry that uses a common protocol/**
	 * Get a URL to the bundle entry that uses a common protocol (i.e. file:
	 * jar: or http: etc.).  
	 * @return a URL to the bundle entry that uses a common protocol
	 */
	public abstract URL getLocalURL();

	
Get a URL to the content of the bundle entry that uses the file: protocol.
The content of the bundle entry may be downloaded or extracted to the local
file system in order to create a file: URL.
Returns:
a URL to the content of the bundle entry that uses the file: protocol/**
	 * Get a URL to the content of the bundle entry that uses the file: protocol.
	 * The content of the bundle entry may be downloaded or extracted to the local
	 * file system in order to create a file: URL.
	 * @return a URL to the content of the bundle entry that uses the file: protocol
	 */
	public abstract URL getFileURL();

	
Return the name of this BundleEntry by calling getName().
Returns:
String representation of this BundleEntry./**
	 * Return the name of this BundleEntry by calling getName().
	 *
	 * @return String representation of this BundleEntry.
	 */
	@Override
	public String toString() {
		return (getName());
	}

	
Used for class loading.  This default implementation gets the input stream from this entry
and copies the content into a byte array.
Throws:
IOException – 
Returns:
a byte array containing the content of this entry/**
	 * Used for class loading.  This default implementation gets the input stream from this entry
	 * and copies the content into a byte array.
	 * @return a byte array containing the content of this entry
	 * @throws IOException
	 */
	public byte[] getBytes() throws IOException {
		InputStream in = getInputStream();
		int length = (int) getSize();
		//		if (Debug.DEBUG_LOADER)
		//			Debug.println("  about to read " + length + " bytes from " + getName()); //$NON-NLS-1$ //$NON-NLS-2$
		return StorageUtil.getBytes(in, length, BUF_SIZE);
	}
}