io.micronaut.cli.io.support

Class AbstractFileResolvingResource

java.lang.Object

io.micronaut.cli.io.support.AbstractFileResolvingResource

All Implemented Interfaces:

Resource

Direct Known Subclasses:

ClassPathResource, UrlResource

public abstract class AbstractFileResolvingResource
extends Object
implements Resource

Abstract base class for resources which resolve URLs into File references, such as org.springframework.core.io.UrlResource or org.springframework.core.io.ClassPathResource.

Detects the "file" protocol as well as the JBoss "vfs" protocol in URLs, resolving file system references accordingly.

Based on https://github.com/spring-projects/spring-framework/blob/master/spring-core/src/main/java/org/springframework/core/io/AbstractFileResolvingResource.java

Since:

1.0

Author:

Juergen Hoeller

Constructor Summary

Constructors

Constructor and Description
AbstractFileResolvingResource()

Method Summary

Modifier and Type	Method and Description
long	contentLength() Determine the content length for this resource.
boolean	exists() Return whether this resource actually exists in physical form.
File	getFile()
protected File	getFile(URI uri) This implementation returns a File reference for the underlying class path resource, provided that it refers to a file in the file system.
protected File	getFileForLastModifiedCheck() This implementation determines the underlying File (or jar file, in case of a resource in a jar/zip).
boolean	isReadable() Return whether the contents of this resource can be read, e.g.
long	lastModified() Determine the last-modified timestamp for this resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.micronaut.cli.io.support.Resource

createRelative, getDescription, getFilename, getInputStream, getURI, getURL

Constructor Detail

AbstractFileResolvingResource

public AbstractFileResolvingResource()

Method Detail

getFile

public File getFile()
             throws IOException

Specified by:

getFile in interface Resource

Returns:

A File handle for this resource.

Throws:

IOException - if the resource cannot be resolved as absolute file path, i.e. if the resource is not available in a file system

exists

public boolean exists()

Description copied from interface: Resource

Return whether this resource actually exists in physical form.

This method performs a definitive existence check, whereas the existence of a Resource handle only guarantees a valid descriptor handle.

Specified by:

exists in interface Resource

Returns:

Whether the resource exists

isReadable

public boolean isReadable()

Description copied from interface: Resource

Return whether the contents of this resource can be read, e.g. via Resource.getInputStream() or Resource.getFile().

Will be true for typical resource descriptors; note that actual content reading may still fail when attempted. However, a value of false is a definitive indication that the resource content cannot be read.

Specified by:

isReadable in interface Resource

Returns:

Where the contents can be read

See Also:

Resource.getInputStream()

contentLength

public long contentLength()
                   throws IOException

Description copied from interface: Resource

Determine the content length for this resource.

Specified by:

contentLength in interface Resource

Returns:

The content length

Throws:

IOException - if the resource cannot be resolved (in the file system or as some other known physical resource type)

lastModified

public long lastModified()
                  throws IOException

Description copied from interface: Resource

Determine the last-modified timestamp for this resource.

Specified by:

lastModified in interface Resource

Returns:

The last-modified timestamp

Throws:

IOException - if the resource cannot be resolved (in the file system or as some other known physical resource type)

getFileForLastModifiedCheck

protected File getFileForLastModifiedCheck()
                                    throws IOException

This implementation determines the underlying File (or jar file, in case of a resource in a jar/zip).

Returns:

The file

Throws:

IOException - if there is an error

getFile

protected File getFile(URI uri)
                throws IOException

This implementation returns a File reference for the underlying class path resource, provided that it refers to a file in the file system.

Parameters:

uri - The URI

Returns:

The file

Throws:

IOException - if there is an error