ArchiveEntry.java

/*
 *  Copyright 2012 The Solmix Project
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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 may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.gnu.org/licenses/ 
 * or see the FSF site: http://www.fsf.org. 
 */
package org.solmix.api.repo.archive;

import org.solmix.api.repo.NamedInputStream;


/**
 * 
 * @author solmix.f@gmail.com
 * @version $Id$  2013年11月23日
 */

public interface ArchiveEntry
{
    /**
     * 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.
     *
     * @return The name relative to the archive root
     */
    public String getNameWithinArchive();

    /**
     * Get access to the stream for the entry
     *
     * @return Obtain stream access to the entry
     */
    public NamedInputStream getNamedInputStream();
}