Copyright (c) 2000, 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) 2000, 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.debug.core.sourcelookup.containers;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.debug.core.DebugPlugin;
import org.eclipse.debug.core.sourcelookup.ISourceContainerType;
import org.eclipse.debug.core.sourcelookup.ISourceLookupDirector;

Archive source container for an archive in the workspace. Returns instances
of ZipEntryStorage as source elements.

Clients may instantiate this class.

Since:
3.0
@noextend
This class is not intended to be subclassed by clients./**
 * Archive source container for an archive in the workspace. Returns instances
 * of <code>ZipEntryStorage</code> as source elements.
 * <p>
 * Clients may instantiate this class.
 * </p>
 * @since 3.0
 * @noextend This class is not intended to be subclassed by clients.
 */
public class ArchiveSourceContainer extends AbstractSourceContainer {

	private IFile fFile;
	private boolean fDetectRoot;
	private ExternalArchiveSourceContainer fDelegateContainer;

	
Unique identifier for the archive source container type
(value org.eclipse.debug.core.containerType.archive).
/**
	 * Unique identifier for the archive source container type
	 * (value <code>org.eclipse.debug.core.containerType.archive</code>).
	 */
	public static final String TYPE_ID = DebugPlugin.getUniqueIdentifier() + ".containerType.archive";	 //$NON-NLS-1$

	
Creates an archive source container on the given file.
Params:
archive – archive in the workspace
detectRootPath – whether a root path should be detected. When
  true, searching is performed relative to a root path
  within the archive based on fully qualified file names. The root
  path is automatically determined when the first successful search
  is performed. For example, when searching for a file named
  a/b/c.d, and an entry in the archive named
  r/a/b/c.d exists, the root path is set to r.
  From that point on, searching is performed relative to r.
  When false, searching is performed by
  matching file names as suffixes to the entries in the archive./**
	 * Creates an archive source container on the given file.
	 *
	 * @param archive archive in the workspace
	 * @param detectRootPath whether a root path should be detected. When
	 *   <code>true</code>, searching is performed relative to a root path
	 *   within the archive based on fully qualified file names. The root
	 *   path is automatically determined when the first successful search
	 *   is performed. For example, when searching for a file named
	 *   <code>a/b/c.d</code>, and an entry in the archive named
	 *   <code>r/a/b/c.d</code> exists, the root path is set to <code>r</code>.
	 *   From that point on, searching is performed relative to <code>r</code>.
	 *   When <code>false</code>, searching is performed by
	 *   matching file names as suffixes to the entries in the archive.
	 */
	public ArchiveSourceContainer(IFile archive, boolean detectRootPath) {
		fFile = archive;
		fDetectRoot = detectRootPath;
		if (archive.exists() && archive.getLocation() != null) {
			fDelegateContainer = new ExternalArchiveSourceContainer(archive.getLocation().toOSString(), detectRootPath);
		}
	}

	@Override
	public String getName() {
		return fFile.getName();
	}

	
Returns the associated file in the workspace.
Returns:
associated file in the workspace/**
	 * Returns the associated file in the workspace.
	 *
	 * @return associated file in the workspace
	 */
	public IFile getFile() {
		return fFile;
	}

	@Override
	public ISourceContainerType getType() {
		return getSourceContainerType(TYPE_ID);
	}

	@Override
	public boolean equals(Object obj) {
		return obj instanceof ArchiveSourceContainer &&
			((ArchiveSourceContainer)obj).getName().equals(getName());
	}

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

	@Override
	public Object[] findSourceElements(String name) throws CoreException {
		ExternalArchiveSourceContainer container = getDelegateContainer();
		if (container != null) {
			return container.findSourceElements(name);
		}
		return EMPTY;
	}

	
Returns the underlying external archive source container.
Returns:
underlying external archive source container
Since:
3.0.1.1/**
	 * Returns the underlying external archive source container.
	 *
	 * @return underlying external archive source container
	 * @since 3.0.1.1
	 */
	private ExternalArchiveSourceContainer getDelegateContainer() {
		return fDelegateContainer;
	}
	@Override
	public void init(ISourceLookupDirector director) {
		super.init(director);
		if (fDelegateContainer != null) {
			fDelegateContainer.init(director);
		}
	}
	@Override
	public void dispose() {
		super.dispose();
		if (fDelegateContainer != null) {
			fDelegateContainer.dispose();
		}
	}

	
Returns whether root paths are automatically detected in this
archive source container.
Returns:
whether root paths are automatically detected in this
archive source container
Since:
3.0.1.1/**
	 * Returns whether root paths are automatically detected in this
	 * archive source container.
	 *
	 * @return whether root paths are automatically detected in this
	 * archive source container
	 * @since 3.0.1.1
	 */
	public boolean isDetectRoot() {
		return fDetectRoot;
	}
}