ResourceUtils (micronaut 2.0.0.BUILD-SNAPSHOT API)

java.lang.Object
- io.micronaut.cli.io.support.ResourceUtils

```
public class ResourceUtils
extends Object
```
Utility methods for resource handling / figuring out class names.

Since:

1.0

Author:

Graeme Rocher, Juergen Hoeller

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`FILE_URL_PREFIX` URL prefix for loading from the file system: "file:".
`static String`	`JAR_URL_SEPARATOR` The JAR URL separator.
`static Pattern[]`	`patterns` Resources are resolved against the platform specific path and must therefore obey the specific File.separator.
`static String`	`REGEX_FILE_SEPARATOR` Regex file separator.
`static String`	`URL_PROTOCOL_CODE_SOURCE` URL protocol for an entry from an OC4J jar file: "code-source".
`static String`	`URL_PROTOCOL_FILE` URL protocol for a file in the file system: "file".
`static String`	`URL_PROTOCOL_JAR` URL protocol for an entry from a jar file: "jar".
`static String`	`URL_PROTOCOL_VFS` URL protocol for a JBoss VFS resource: "vfs".
`static String`	`URL_PROTOCOL_WSJAR` URL protocol for an entry from a WebSphere jar file: "wsjar".
`static String`	`URL_PROTOCOL_ZIP` URL protocol for an entry from a zip file: "zip".

Constructor Summary

Constructors
Constructor and Description

ResourceUtils()

Constructors
Constructor and Description
`ResourceUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`applyRelativePath(String path, String relativePath)` Apply the given relative path to the given path, assuming standard Java folder separation (i.e.
`static String`	`classPackageAsResourcePath(Class<?> clazz)` Given an input class object, return a string which consists of the class's package name as a pathname, i.e., all dots ('.') are replaced by slashes ('/').
`static String`	`cleanPath(String path)` Normalize the path by suppressing sequences like "path/.." and inner simple dots.
`static URL`	`extractJarFileURL(URL jarUrl)` Extract the URL for the actual jar file from the given URL (which may point to a resource in a jar file or to a jar file itself).
`static String`	`getClassName(Resource resource)` Gets the class name of the specified Micronaut resource.
`static String`	`getClassName(String path)` Returns the class name for a resource.
`static File`	`getFile(URI resourceUri, String description)` Resolve the given resource URI to a `java.io.File`, i.e.
`static File`	`getFile(URL resourceUrl, String description)` Resolve the given resource URL to a `java.io.File`, i.e.
`static String`	`getFilename(String path)` Extract the filename from the given path, e.g.
`static boolean`	`isFileURL(URL url)` Determine whether the given URL points to a resource in the file system, that is, has protocol "file" or "vfs".
`static boolean`	`isJarURL(URL url)` Determine whether the given URL points to a resource in a jar file, that is, has protocol "jar", "zip", "wsjar" or "code-source".
`static URI`	`toURI(String location)` Create a URI instance for the given location String, replacing spaces with "%20" quotes first.
`static URI`	`toURI(URL url)` Create a URI instance for the given URL, replacing spaces with "%20" quotes first.
`static void`	`useCachesIfNecessary(URLConnection con)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - JAR_URL_SEPARATOR
```
public static final String JAR_URL_SEPARATOR
```
    The JAR URL separator.
    
    See Also:
    
    Constant Field Values
  - FILE_URL_PREFIX
```
public static final String FILE_URL_PREFIX
```
    URL prefix for loading from the file system: "file:".
    
    See Also:
    
    Constant Field Values
  - URL_PROTOCOL_FILE
```
public static final String URL_PROTOCOL_FILE
```
    URL protocol for a file in the file system: "file".
    
    See Also:
    
    Constant Field Values
  - URL_PROTOCOL_JAR
```
public static final String URL_PROTOCOL_JAR
```
    URL protocol for an entry from a jar file: "jar".
    
    See Also:
    
    Constant Field Values
  - URL_PROTOCOL_ZIP
```
public static final String URL_PROTOCOL_ZIP
```
    URL protocol for an entry from a zip file: "zip".
    
    See Also:
    
    Constant Field Values
  - URL_PROTOCOL_VFS
```
public static final String URL_PROTOCOL_VFS
```
    URL protocol for a JBoss VFS resource: "vfs".
    
    See Also:
    
    Constant Field Values
  - URL_PROTOCOL_WSJAR
```
public static final String URL_PROTOCOL_WSJAR
```
    URL protocol for an entry from a WebSphere jar file: "wsjar".
    
    See Also:
    
    Constant Field Values
  - URL_PROTOCOL_CODE_SOURCE
```
public static final String URL_PROTOCOL_CODE_SOURCE
```
    URL protocol for an entry from an OC4J jar file: "code-source".
    
    See Also:
    
    Constant Field Values
  - REGEX_FILE_SEPARATOR
```
public static final String REGEX_FILE_SEPARATOR
```
    Regex file separator.
    
    See Also:
    
    Constant Field Values
  - patterns
```
public static final Pattern[] patterns
```
    Resources are resolved against the platform specific path and must therefore obey the specific File.separator.
- Constructor Detail
  - ResourceUtils
```
public ResourceUtils()
```
- Method Detail
  - getFilename
```
public static String getFilename(String path)
```
    Extract the filename from the given path, e.g. "mypath/myfile.txt" -> "myfile.txt".
    
    Parameters:
    
    path - the file path (may be null)
    
    Returns:
    
    the extracted filename, or null if none
  - classPackageAsResourcePath
```
public static String classPackageAsResourcePath(Class<?> clazz)
```
    Given an input class object, return a string which consists of the class's package name as a pathname, i.e., all dots ('.') are replaced by slashes ('/'). Neither a leading nor trailing slash is added. The result could be concatenated with a slash and the name of a resource and fed directly to ClassLoader.getResource(). For it to be fed to Class.getResource instead, a leading slash would also have to be prepended to the returned value.
    
    Parameters:
    
    clazz - the input class. A null value or the default (empty) package will result in an empty string ("") being returned.
    
    Returns:
    
    a path which represents the package name
    
    See Also:
    
    ClassLoader.getResource(java.lang.String), Class.getResource(java.lang.String)
  - useCachesIfNecessary
```
public static void useCachesIfNecessary(URLConnection con)
```
    Parameters:
    
    con - The URL connection
  - getClassName
```
public static String getClassName(Resource resource)
```
    Gets the class name of the specified Micronaut resource.
    
    Parameters:
    
    resource - The Spring Resource
    
    Returns:
    
    The class name or null if the resource is not a Micronaut class
  - getClassName
```
public static String getClassName(String path)
```
    Returns the class name for a resource.
    
    Parameters:
    
    path - The path to check
    
    Returns:
    
    The class name or null if it doesn't exist
  - getFile
```
public static File getFile(URL resourceUrl,
                           String description)
                    throws FileNotFoundException
```
    Resolve the given resource URL to a java.io.File, i.e. to a file in the file system.
    
    Parameters:
    
    resourceUrl - the resource URL to resolve
    
    description - a description of the original resource that the URL was created for (for example, a class path location)
    
    Returns:
    
    a corresponding File object
    
    Throws:
    
    FileNotFoundException - if the URL cannot be resolved to a file in the file system
  - isJarURL
```
public static boolean isJarURL(URL url)
```
    Determine whether the given URL points to a resource in a jar file, that is, has protocol "jar", "zip", "wsjar" or "code-source".
    "zip" and "wsjar" are used by BEA WebLogic Server and IBM WebSphere, respectively, but can be treated like jar files. The same applies to "code-source" URLs on Oracle OC4J, provided that the path contains a jar separator.
    
    Parameters:
    
    url - the URL to check
    
    Returns:
    
    whether the URL has been identified as a JAR URL
  - getFile
```
public static File getFile(URI resourceUri,
                           String description)
                    throws FileNotFoundException
```
    Resolve the given resource URI to a java.io.File, i.e. to a file in the file system.
    
    Parameters:
    
    resourceUri - the resource URI to resolve
    
    description - a description of the original resource that the URI was created for (for example, a class path location)
    
    Returns:
    
    a corresponding File object
    
    Throws:
    
    FileNotFoundException - if the URL cannot be resolved to a file in the file system
  - toURI
```
public static URI toURI(URL url)
                 throws URISyntaxException
```
    Create a URI instance for the given URL, replacing spaces with "%20" quotes first.
    Furthermore, this method works on JDK 1.4 as well, in contrast to the URL.toURI() method.
    
    Parameters:
    
    url - the URL to convert into a URI instance
    
    Returns:
    
    the URI instance
    
    Throws:
    
    URISyntaxException - if the URL wasn't a valid URI
    
    See Also:
    
    URL.toURI()
  - isFileURL
```
public static boolean isFileURL(URL url)
```
    Determine whether the given URL points to a resource in the file system, that is, has protocol "file" or "vfs".
    
    Parameters:
    
    url - the URL to check
    
    Returns:
    
    whether the URL has been identified as a file system URL
  - applyRelativePath
```
public static String applyRelativePath(String path,
                                       String relativePath)
```
    Apply the given relative path to the given path, assuming standard Java folder separation (i.e. "/" separators).
    
    Parameters:
    
    path - the path to start from (usually a full file path)
    
    relativePath - the relative path to apply (relative to the full file path above)
    
    Returns:
    
    the full file path that results from applying the relative path
  - cleanPath
```
public static String cleanPath(String path)
```
    Normalize the path by suppressing sequences like "path/.." and inner simple dots.
    The result is convenient for path comparison. For other uses, notice that Windows separators ("\") are replaced by simple slashes.
    
    Parameters:
    
    path - the original path
    
    Returns:
    
    the normalized path
  - extractJarFileURL
```
public static URL extractJarFileURL(URL jarUrl)
                             throws MalformedURLException
```
    Extract the URL for the actual jar file from the given URL (which may point to a resource in a jar file or to a jar file itself).
    
    Parameters:
    
    jarUrl - the original URL
    
    Returns:
    
    the URL for the actual jar file
    
    Throws:
    
    MalformedURLException - if no valid jar file URL could be extracted
  - toURI
```
public static URI toURI(String location)
                 throws URISyntaxException
```
    Create a URI instance for the given location String, replacing spaces with "%20" quotes first.
    
    Parameters:
    
    location - the location String to convert into a URI instance
    
    Returns:
    
    the URI instance
    
    Throws:
    
    URISyntaxException - if the location wasn't a valid URI

Class ResourceUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JAR_URL_SEPARATOR

FILE_URL_PREFIX

URL_PROTOCOL_FILE

URL_PROTOCOL_JAR

URL_PROTOCOL_ZIP

URL_PROTOCOL_VFS

URL_PROTOCOL_WSJAR

URL_PROTOCOL_CODE_SOURCE

REGEX_FILE_SEPARATOR

patterns

Constructor Detail

ResourceUtils

Method Detail

getFilename

classPackageAsResourcePath

useCachesIfNecessary

getClassName

getClassName

getFile

isJarURL

getFile

toURI

isFileURL

applyRelativePath

cleanPath

extractJarFileURL

toURI