/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * Copyright (c) 2013, Red Hat Inc. or third-party contributors as
 * indicated by the @author tags or express copyright attribution
 * statements applied by the authors.  All third-party contributions are
 * distributed under license by Red Hat Inc.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.hibernate.jpa.boot.archive.spi;

import org.hibernate.jpa.boot.spi.InputStreamAccess;

Represent an entry in the archive.
Author:
Steve Ebersole/**
 * Represent an entry in the archive.
 *
 * @author Steve Ebersole
 */
public interface ArchiveEntry {
	
Get the entry's name
Returns:
The name/**
	 * Get the entry's name
	 *
	 * @return The name
	 */
	public String getName();

	
Get the relative name of the entry within the archive.  Typically what we are looking for here is
the ClassLoader resource lookup name.
Returns:
The name relative to the archive root/**
	 * Get the relative name of the entry within the archive.  Typically what we are looking for here is
	 * the ClassLoader resource lookup name.
	 *
	 * @return The name relative to the archive root
	 */
	public String getNameWithinArchive();

	
Get access to the stream for the entry
Returns:
Obtain stream access to the entry/**
	 * Get access to the stream for the entry
	 *
	 * @return Obtain stream access to the entry
	 */
	public InputStreamAccess getStreamAccess();
}