org.jboss.modules.Resource Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source.
* Copyright 2010, Red Hat, Inc., and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* 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 should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.modules;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
/**
* A single resource from a {@link ResourceLoader}.
*
* @author David M. Lloyd
*/
public interface Resource {
/**
* Get the relative resource name.
*
* @return the name
*/
String getName();
/**
* Get the complete URL of this resource.
*
* @return the URL
*/
URL getURL();
/**
* Open an input stream to this resource.
*
* @return the stream
* @throws java.io.IOException if an I/O error occurs
*/
InputStream openStream() throws IOException;
/**
* Get the size of the resource, if known.
*
* @return the size, or 0L if unknown
*/
long getSize();
}