org.codehaus.plexus.resource
Class DefaultResourceManager

java.lang.Object
  extended by org.codehaus.plexus.logging.AbstractLogEnabled
      extended by org.codehaus.plexus.resource.DefaultResourceManager
All Implemented Interfaces:
org.codehaus.plexus.logging.LogEnabled, ResourceManager

public class DefaultResourceManager
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements ResourceManager

Version:
$Id: DefaultResourceManager.java 8647 2010-02-15 00:08:07Z olamy $
Author:
Trygve Laugstøl, Jason van Zyl

Field Summary
 
Fields inherited from interface org.codehaus.plexus.resource.ResourceManager
ROLE
 
Constructor Summary
DefaultResourceManager()
           
 
Method Summary
 void addSearchPath(String id, String path)
           
 void createResourceAsFile(PlexusResource resource, File outputFile)
          Downloads the resource to the given output file.
 PlexusResource getResource(String name)
          Searches for a resource with the given name.
 File getResourceAsFile(PlexusResource resource)
          Returns a file with the given resources contents.
 File getResourceAsFile(String name)
           
 File getResourceAsFile(String name, String outputPath)
           
 InputStream getResourceAsInputStream(String name)
           
 File resolveLocation(String name)
          Provides compatibility with the Locator utility used by several Maven Plugins.
 File resolveLocation(String name, String outputPath)
          Provides compatibility with the Locator utility used by several Maven Plugins.
 void setOutputDirectory(File outputDirectory)
           
 
Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultResourceManager

public DefaultResourceManager()
Method Detail

getResourceAsInputStream

public InputStream getResourceAsInputStream(String name)
                                     throws ResourceNotFoundException
Specified by:
getResourceAsInputStream in interface ResourceManager
Throws:
ResourceNotFoundException

getResourceAsFile

public File getResourceAsFile(String name)
                       throws ResourceNotFoundException,
                              FileResourceCreationException
Specified by:
getResourceAsFile in interface ResourceManager
Throws:
ResourceNotFoundException
FileResourceCreationException

getResourceAsFile

public File getResourceAsFile(String name,
                              String outputPath)
                       throws ResourceNotFoundException,
                              FileResourceCreationException
Specified by:
getResourceAsFile in interface ResourceManager
Throws:
ResourceNotFoundException
FileResourceCreationException

resolveLocation

public File resolveLocation(String name,
                            String outputPath)
                     throws IOException
Description copied from interface: ResourceManager
Provides compatibility with the Locator utility used by several Maven Plugins.

Specified by:
resolveLocation in interface ResourceManager
Throws:
IOException

resolveLocation

public File resolveLocation(String name)
                     throws IOException
Description copied from interface: ResourceManager
Provides compatibility with the Locator utility used by several Maven Plugins.

Specified by:
resolveLocation in interface ResourceManager
Throws:
IOException

setOutputDirectory

public void setOutputDirectory(File outputDirectory)
Specified by:
setOutputDirectory in interface ResourceManager

addSearchPath

public void addSearchPath(String id,
                          String path)
Specified by:
addSearchPath in interface ResourceManager

getResource

public PlexusResource getResource(String name)
                           throws ResourceNotFoundException
Description copied from interface: ResourceManager
Searches for a resource with the given name.

Specified by:
getResource in interface ResourceManager
Throws:
ResourceNotFoundException

getResourceAsFile

public File getResourceAsFile(PlexusResource resource)
                       throws FileResourceCreationException
Description copied from interface: ResourceManager
Returns a file with the given resources contents. If the resource is already available as a file, returns that file. Otherwise, a file in the resource managers output directory is created and the resource is downloaded to that file.

Specified by:
getResourceAsFile in interface ResourceManager
Throws:
FileResourceCreationException

createResourceAsFile

public void createResourceAsFile(PlexusResource resource,
                                 File outputFile)
                          throws FileResourceCreationException
Description copied from interface: ResourceManager
Downloads the resource to the given output file.

Specified by:
createResourceAsFile in interface ResourceManager
Throws:
FileResourceCreationException


Copyright © 2001-2011 Codehaus. All Rights Reserved.