apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/StubArchiveApiTypeContainer.java - pde/eclipse.pde.ui - Git at Google

 /*******************************************************************************
  * Copyright (c) 2009, 2013 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
  *
  * Contributors:
  *     IBM Corporation - initial API and implementation
  *******************************************************************************/
 package org.eclipse.pde.api.tools.internal.model;

 import java.io.IOException;
 import java.io.InputStream;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.Enumeration;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipFile;

 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.pde.api.tools.internal.provisional.ApiPlugin;
 import org.eclipse.pde.api.tools.internal.provisional.model.ApiTypeContainerVisitor;
 import org.eclipse.pde.api.tools.internal.provisional.model.IApiElement;
 import org.eclipse.pde.api.tools.internal.provisional.model.IApiType;
 import org.eclipse.pde.api.tools.internal.provisional.model.IApiTypeContainer;
 import org.eclipse.pde.api.tools.internal.provisional.model.IApiTypeRoot;
 import org.eclipse.pde.api.tools.internal.util.Util;

 /**
  * {@link IApiTypeContainer} container for an archive (jar or zip) file.
  *
  * @since 1.0.0
  */
 public class StubArchiveApiTypeContainer extends ApiElement implements IApiTypeContainer {

 	/**
 	 * {@link IApiTypeRoot} implementation within an archive
 	 */
 	static class ArchiveApiTypeRoot extends AbstractApiTypeRoot implements Comparable<Object> {

 		private String fTypeName;

 		@Override
 		public IApiType getStructure() throws CoreException {
 			return TypeStructureBuilder.buildStubTypeStructure(getContents(), getApiComponent(), this);
 		}

 		/**
 		 * Constructs a new handle to an {@link IApiTypeRoot} in the archive.
 		 *
 		 * @param container archive
 		 * @param entryName zip entry name
 		 */
 		public ArchiveApiTypeRoot(StubArchiveApiTypeContainer container, String entryName) {
 			super(container, entryName);
 		}

 		@Override
 		public String getTypeName() {
 			if (fTypeName == null) {
 				fTypeName = getName().replace('/', '.').substring(0, getName().length() - Util.DOT_CLASS_SUFFIX.length());
 			}
 			return fTypeName;
 		}

 		@Override
 		public int compareTo(Object o) {
 			return getTypeName().compareTo(((ArchiveApiTypeRoot) o).getTypeName());
 		}

 		/**
 		 * @see java.lang.Object#equals(java.lang.Object)
 		 */
 		@Override
 		public boolean equals(Object obj) {
 			if (obj instanceof ArchiveApiTypeRoot) {
 				ArchiveApiTypeRoot classFile = (ArchiveApiTypeRoot) obj;
 				return this.getName().equals(classFile.getName());
 			}
 			return false;
 		}

 		/**
 		 * @see java.lang.Object#hashCode()
 		 */
 		@Override
 		public int hashCode() {
 			return getName().hashCode();
 		}

 		@Override
 		public byte[] getContents() throws CoreException {
 			StubArchiveApiTypeContainer archive = (StubArchiveApiTypeContainer) getParent();
 			ZipFile zipFile = archive.open();
 			ZipEntry entry = zipFile.getEntry(getName());
 			InputStream stream = null;
 			if (entry != null) {
 				try {
 					stream = zipFile.getInputStream(entry);
 				} catch (IOException e) {
 					abort("Failed to open class file: " + getTypeName() + " in archive: " + archive.fLocation, e); //$NON-NLS-1$ //$NON-NLS-2$
 					return null;
 				}
 				try {
 					return Util.getInputStreamAsByteArray(stream, -1);
 				} catch (IOException ioe) {
 					abort("Unable to read class file: " + getTypeName(), ioe); //$NON-NLS-1$
 					return null; // never gets here
 				} finally {
 					try {
 						stream.close();
 					} catch (IOException e) {
 						ApiPlugin.log(e);
 					}
 				}
 			}
 			abort("Class file not found: " + getTypeName() + " in archive: " + archive.fLocation, null); //$NON-NLS-1$ //$NON-NLS-2$
 			return null;
 		}
 	}

 	/**
 	 * Location of the archive in the local file system.
 	 */
 	String fLocation;

 	/**
 	 * Cache of package names to class file paths in that package, or
 	 * <code>null</code> if not yet initialized.
 	 */
 	private Map<String, Set<String>> fPackages;

 	/**
 	 * Cache of package names in this archive.
 	 */
 	private String[] fPackageNames;

 	/**
 	 * Open zip file, or <code>null</code> if file is currently closed.
 	 */
 	private ZipFile fZipFile = null;

 	/**
 	 * Constructs an {@link IApiTypeContainer} container for the given jar or
 	 * zip file at the specified location.
 	 *
 	 * @param parent the parent {@link IApiElement} or <code>null</code> if none
 	 * @param path location of the file in the local file system
 	 */
 	public StubArchiveApiTypeContainer(IApiElement parent, String path) {
 		super(parent, IApiElement.API_TYPE_CONTAINER, path);
 		this.fLocation = path;
 	}

 	/**
 	 * @see org.eclipse.pde.api.tools.internal.AbstractApiTypeContainer#accept(org.eclipse.pde.api.tools.internal.provisional.ApiTypeContainerVisitor)
 	 */
 	@Override
 	public void accept(ApiTypeContainerVisitor visitor) throws CoreException {
 		if (visitor.visit(this)) {
 			init();
 			List<String> packages = new ArrayList<>(fPackages.keySet());
 			Collections.sort(packages);
 			for (String pkg : packages) {
 				if (visitor.visitPackage(pkg)) {
 					List<String> types = new ArrayList<>(fPackages.get(pkg));
 					List<ArchiveApiTypeRoot> classFiles = new ArrayList<>(types.size());
 					for (String entryName : types) {
 						classFiles.add(new ArchiveApiTypeRoot(this, entryName));
 					}
 					Collections.sort(classFiles);
 					for (ArchiveApiTypeRoot classFile : classFiles) {
 						visitor.visit(pkg, classFile);
 						visitor.end(pkg, classFile);
 					}
 				}
 				visitor.endVisitPackage(pkg);
 			}
 		}
 		visitor.end(this);
 	}

 	/**
 	 * @see java.lang.Object#toString()
 	 */
 	@Override
 	public String toString() {
 		StringBuilder buff = new StringBuilder();
 		buff.append("Archive Class File Container: " + getName()); //$NON-NLS-1$
 		return buff.toString();
 	}

 	/**
 	 * @see org.eclipse.pde.api.tools.internal.AbstractApiTypeContainer#close()
 	 */
 	@Override
 	public synchronized void close() throws CoreException {
 		if (fZipFile != null) {
 			try {
 				fZipFile.close();
 				fZipFile = null;
 			} catch (IOException e) {
 				abort("Failed to close class file archive", e); //$NON-NLS-1$
 			}
 		}
 	}

 	/**
 	 * @see org.eclipse.pde.api.tools.internal.provisional.IApiTypeContainer#findTypeRoot(java.lang.String)
 	 */
 	@Override
 	public IApiTypeRoot findTypeRoot(String qualifiedName) throws CoreException {
 		init();
 		int index = qualifiedName.lastIndexOf('.');
 		String packageName = Util.DEFAULT_PACKAGE_NAME;
 		if (index >= 0) {
 			packageName = qualifiedName.substring(0, index);
 		}
 		Set<String> classFileNames = fPackages.get(packageName);
 		if (classFileNames != null) {
 			String fileName = qualifiedName.replace('.', '/');
 			if (classFileNames.contains(fileName)) {
 				return new ArchiveApiTypeRoot(this, fileName);
 			}
 		}
 		return null;
 	}

 	/**
 	 * @see org.eclipse.pde.api.tools.internal.AbstractApiTypeContainer#getPackageNames()
 	 */
 	@Override
 	public String[] getPackageNames() throws CoreException {
 		init();
 		synchronized (this) {
 			if (fPackageNames == null) {
 				Set<String> names = fPackages.keySet();
 				String[] result = new String[names.size()];
 				names.toArray(result);
 				Arrays.sort(result);
 				fPackageNames = result;
 			}
 			return fPackageNames;
 		}
 	}

 	/**
 	 * Initializes cache of packages and types.
 	 *
 	 * @throws CoreException
 	 */
 	private synchronized void init() throws CoreException {
 		ZipFile zipFile = open();
 		if (fPackages == null) {
 			fPackages = new HashMap<>();
 			Enumeration<? extends ZipEntry> entries = zipFile.entries();
 			while (entries.hasMoreElements()) {
 				ZipEntry entry = entries.nextElement();
 				String name = entry.getName();
 				String pkg = Util.DEFAULT_PACKAGE_NAME;
 				int index = name.lastIndexOf('/');
 				if (index >= 0) {
 					pkg = name.substring(0, index).replace('/', '.');
 				}
 				Set<String> fileNames = fPackages.get(pkg);
 				if (fileNames == null) {
 					fileNames = new HashSet<>();
 					fPackages.put(pkg, fileNames);
 				}
 				fileNames.add(name);
 			}
 		}
 	}

 	/**
 	 * Returns an open zip file for this archive.
 	 *
 	 * @return zip file
 	 * @throws IOException if unable to open the archive
 	 */
 	synchronized ZipFile open() throws CoreException {
 		if (fZipFile == null) {
 			try {
 				fZipFile = new ZipFile(fLocation);
 			} catch (IOException e) {
 				abort("Failed to open archive: " + fLocation, e); //$NON-NLS-1$
 			}
 		}
 		return fZipFile;
 	}

 	@Override
 	public boolean equals(Object obj) {
 		if (obj instanceof StubArchiveApiTypeContainer) {
 			return this.fLocation.equals(((StubArchiveApiTypeContainer) obj).fLocation);
 		}
 		return false;
 	}

 	@Override
 	public int hashCode() {
 		return this.fLocation.hashCode();
 	}

 	/**
 	 * @see org.eclipse.pde.api.tools.internal.provisional.IApiTypeContainer#findTypeRoot(java.lang.String,
 	 *      java.lang.String)
 	 */
 	@Override
 	public IApiTypeRoot findTypeRoot(String qualifiedName, String id) throws CoreException {
 		return findTypeRoot(qualifiedName);
 	}

 	@Override
 	public int getContainerType() {
 		return ARCHIVE;
 	}
 }
	/*******************************************************************************
	* Copyright (c) 2009, 2013 IBM Corporation and others.
	* All rights reserved. This program and the accompanying materials
	* are made available under the terms of the Eclipse Public License v1.0
	* which accompanies this distribution, and is available at
	* http://www.eclipse.org/legal/epl-v10.html
	*
	* Contributors:
	* IBM Corporation - initial API and implementation
	*******************************************************************************/
	package org.eclipse.pde.api.tools.internal.model;

	import java.io.IOException;
	import java.io.InputStream;
	import java.util.ArrayList;
	import java.util.Arrays;
	import java.util.Collections;
	import java.util.Enumeration;
	import java.util.HashMap;
	import java.util.HashSet;
	import java.util.List;
	import java.util.Map;
	import java.util.Set;
	import java.util.zip.ZipEntry;
	import java.util.zip.ZipFile;

	import org.eclipse.core.runtime.CoreException;
	import org.eclipse.pde.api.tools.internal.provisional.ApiPlugin;
	import org.eclipse.pde.api.tools.internal.provisional.model.ApiTypeContainerVisitor;
	import org.eclipse.pde.api.tools.internal.provisional.model.IApiElement;
	import org.eclipse.pde.api.tools.internal.provisional.model.IApiType;
	import org.eclipse.pde.api.tools.internal.provisional.model.IApiTypeContainer;
	import org.eclipse.pde.api.tools.internal.provisional.model.IApiTypeRoot;
	import org.eclipse.pde.api.tools.internal.util.Util;

	/**
	* {@link IApiTypeContainer} container for an archive (jar or zip) file.
	*
	* @since 1.0.0
	*/
	public class StubArchiveApiTypeContainer extends ApiElement implements IApiTypeContainer {

	/**
	* {@link IApiTypeRoot} implementation within an archive
	*/
	static class ArchiveApiTypeRoot extends AbstractApiTypeRoot implements Comparable<Object> {

	private String fTypeName;

	@Override
	public IApiType getStructure() throws CoreException {
	return TypeStructureBuilder.buildStubTypeStructure(getContents(), getApiComponent(), this);
	}

	/**
	* Constructs a new handle to an {@link IApiTypeRoot} in the archive.
	*
	* @param container archive
	* @param entryName zip entry name
	*/
	public ArchiveApiTypeRoot(StubArchiveApiTypeContainer container, String entryName) {
	super(container, entryName);
	}

	@Override
	public String getTypeName() {
	if (fTypeName == null) {
	fTypeName = getName().replace('/', '.').substring(0, getName().length() - Util.DOT_CLASS_SUFFIX.length());
	}
	return fTypeName;
	}

	@Override
	public int compareTo(Object o) {
	return getTypeName().compareTo(((ArchiveApiTypeRoot) o).getTypeName());
	}

	/**
	* @see java.lang.Object#equals(java.lang.Object)
	*/
	@Override
	public boolean equals(Object obj) {
	if (obj instanceof ArchiveApiTypeRoot) {
	ArchiveApiTypeRoot classFile = (ArchiveApiTypeRoot) obj;
	return this.getName().equals(classFile.getName());
	}
	return false;
	}

	/**
	* @see java.lang.Object#hashCode()
	*/
	@Override
	public int hashCode() {
	return getName().hashCode();
	}

	@Override
	public byte[] getContents() throws CoreException {
	StubArchiveApiTypeContainer archive = (StubArchiveApiTypeContainer) getParent();
	ZipFile zipFile = archive.open();
	ZipEntry entry = zipFile.getEntry(getName());
	InputStream stream = null;
	if (entry != null) {
	try {
	stream = zipFile.getInputStream(entry);
	} catch (IOException e) {
	abort("Failed to open class file: " + getTypeName() + " in archive: " + archive.fLocation, e); //$NON-NLS-1$ //$NON-NLS-2$
	return null;
	}
	try {
	return Util.getInputStreamAsByteArray(stream, -1);
	} catch (IOException ioe) {
	abort("Unable to read class file: " + getTypeName(), ioe); //$NON-NLS-1$
	return null; // never gets here
	} finally {
	try {
	stream.close();
	} catch (IOException e) {
	ApiPlugin.log(e);
	}
	}
	}
	abort("Class file not found: " + getTypeName() + " in archive: " + archive.fLocation, null); //$NON-NLS-1$ //$NON-NLS-2$
	return null;
	}
	}

	/**
	* Location of the archive in the local file system.
	*/
	String fLocation;

	/**
	* Cache of package names to class file paths in that package, or
	* <code>null</code> if not yet initialized.
	*/
	private Map<String, Set<String>> fPackages;

	/**
	* Cache of package names in this archive.
	*/
	private String[] fPackageNames;

	/**
	* Open zip file, or <code>null</code> if file is currently closed.
	*/
	private ZipFile fZipFile = null;

	/**
	* Constructs an {@link IApiTypeContainer} container for the given jar or
	* zip file at the specified location.
	*
	* @param parent the parent {@link IApiElement} or <code>null</code> if none
	* @param path location of the file in the local file system
	*/
	public StubArchiveApiTypeContainer(IApiElement parent, String path) {
	super(parent, IApiElement.API_TYPE_CONTAINER, path);
	this.fLocation = path;
	}

	/**
	* @see org.eclipse.pde.api.tools.internal.AbstractApiTypeContainer#accept(org.eclipse.pde.api.tools.internal.provisional.ApiTypeContainerVisitor)
	*/
	@Override
	public void accept(ApiTypeContainerVisitor visitor) throws CoreException {
	if (visitor.visit(this)) {
	init();
	List<String> packages = new ArrayList<>(fPackages.keySet());
	Collections.sort(packages);
	for (String pkg : packages) {
	if (visitor.visitPackage(pkg)) {
	List<String> types = new ArrayList<>(fPackages.get(pkg));
	List<ArchiveApiTypeRoot> classFiles = new ArrayList<>(types.size());
	for (String entryName : types) {
	classFiles.add(new ArchiveApiTypeRoot(this, entryName));
	}
	Collections.sort(classFiles);
	for (ArchiveApiTypeRoot classFile : classFiles) {
	visitor.visit(pkg, classFile);
	visitor.end(pkg, classFile);
	}
	}
	visitor.endVisitPackage(pkg);
	}
	}
	visitor.end(this);
	}

	/**
	* @see java.lang.Object#toString()
	*/
	@Override
	public String toString() {
	StringBuilder buff = new StringBuilder();
	buff.append("Archive Class File Container: " + getName()); //$NON-NLS-1$
	return buff.toString();
	}

	/**
	* @see org.eclipse.pde.api.tools.internal.AbstractApiTypeContainer#close()
	*/
	@Override
	public synchronized void close() throws CoreException {
	if (fZipFile != null) {
	try {
	fZipFile.close();
	fZipFile = null;
	} catch (IOException e) {
	abort("Failed to close class file archive", e); //$NON-NLS-1$
	}
	}
	}

	/**
	* @see org.eclipse.pde.api.tools.internal.provisional.IApiTypeContainer#findTypeRoot(java.lang.String)
	*/
	@Override
	public IApiTypeRoot findTypeRoot(String qualifiedName) throws CoreException {
	init();
	int index = qualifiedName.lastIndexOf('.');
	String packageName = Util.DEFAULT_PACKAGE_NAME;
	if (index >= 0) {
	packageName = qualifiedName.substring(0, index);
	}
	Set<String> classFileNames = fPackages.get(packageName);
	if (classFileNames != null) {
	String fileName = qualifiedName.replace('.', '/');
	if (classFileNames.contains(fileName)) {
	return new ArchiveApiTypeRoot(this, fileName);
	}
	}
	return null;
	}

	/**
	* @see org.eclipse.pde.api.tools.internal.AbstractApiTypeContainer#getPackageNames()
	*/
	@Override
	public String[] getPackageNames() throws CoreException {
	init();
	synchronized (this) {
	if (fPackageNames == null) {
	Set<String> names = fPackages.keySet();
	String[] result = new String[names.size()];
	names.toArray(result);
	Arrays.sort(result);
	fPackageNames = result;
	}
	return fPackageNames;
	}
	}

	/**
	* Initializes cache of packages and types.
	*
	* @throws CoreException
	*/
	private synchronized void init() throws CoreException {
	ZipFile zipFile = open();
	if (fPackages == null) {
	fPackages = new HashMap<>();
	Enumeration<? extends ZipEntry> entries = zipFile.entries();
	while (entries.hasMoreElements()) {
	ZipEntry entry = entries.nextElement();
	String name = entry.getName();
	String pkg = Util.DEFAULT_PACKAGE_NAME;
	int index = name.lastIndexOf('/');
	if (index >= 0) {
	pkg = name.substring(0, index).replace('/', '.');
	}
	Set<String> fileNames = fPackages.get(pkg);
	if (fileNames == null) {
	fileNames = new HashSet<>();
	fPackages.put(pkg, fileNames);
	}
	fileNames.add(name);
	}
	}
	}

	/**
	* Returns an open zip file for this archive.
	*
	* @return zip file
	* @throws IOException if unable to open the archive
	*/
	synchronized ZipFile open() throws CoreException {
	if (fZipFile == null) {
	try {
	fZipFile = new ZipFile(fLocation);
	} catch (IOException e) {
	abort("Failed to open archive: " + fLocation, e); //$NON-NLS-1$
	}
	}
	return fZipFile;
	}

	@Override
	public boolean equals(Object obj) {
	if (obj instanceof StubArchiveApiTypeContainer) {
	return this.fLocation.equals(((StubArchiveApiTypeContainer) obj).fLocation);
	}
	return false;
	}

	@Override
	public int hashCode() {
	return this.fLocation.hashCode();
	}

	/**
	* @see org.eclipse.pde.api.tools.internal.provisional.IApiTypeContainer#findTypeRoot(java.lang.String,
	* java.lang.String)
	*/
	@Override
	public IApiTypeRoot findTypeRoot(String qualifiedName, String id) throws CoreException {
	return findTypeRoot(qualifiedName);
	}

	@Override
	public int getContainerType() {
	return ARCHIVE;
	}
	}