org.gradle.api.internal.resource

Interface Resource

All Superinterfaces:

Serializable

All Known Implementing Classes:

CachingResource, DelegatingResource, StringResource, UriResource

public interface Resource
extends Serializable

A Resource represents some binary artifact.

Implementations are not required to be thread-safe.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDisplayName() Returns a display name for this resource.
boolean	getExists() Returns true if this resource exists, false if it does not exist.
File	getFile() Returns a file representing this resource.
String	getText() Returns the content of this resource, as a String.
URI	getURI() Returns the URI for this resource.

Method Detail

getDisplayName

String getDisplayName()

Returns a display name for this resource. This can be used in log and error messages.

Returns:

the display name

getFile

File getFile()

Returns a file representing this resource. Not all resources are available as a file.

Returns:

A file representing this resource. Returns null if this resource is not available as a file.

getURI

URI getURI()

Returns the URI for this resource. Not all resources have a URI.

Returns:

The URI for this resource. Returns null if this resource does not have a URI.

getExists

boolean getExists()

Returns true if this resource exists, false if it does not exist.

Returns:

true if this resource exists.

getText

String getText()
               throws ResourceNotFoundException

Returns the content of this resource, as a String.

Returns:

the content. Never returns null.

Throws:

ResourceNotFoundException - When this resource does not exist.