com.phloc.commons.io.resource

Class URLResource

java.lang.Object

com.phloc.commons.io.resource.URLResource

All Implemented Interfaces:

IInputStreamAndReaderProvider, IInputStreamProvider, IReadableResource, IResourceBase, Serializable

@Immutable
public class URLResource
extends Object
implements IReadableResource

Implementation of the IReadableResource interface for URL objects.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CONNECT_TIMEOUT
static int	DEFAULT_READ_TIMEOUT
static String	PROTOCOL_FILE The protocol for file resources

Constructor Summary

Constructors

Constructor and Description
URLResource(ISimpleURL aURL)
URLResource(String sURL)
URLResource(URI aURI)
URLResource(URL aURL)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
boolean	exists()
File	getAsFile()
static File	getAsFile(URL aURL)
URI	getAsURI()
URL	getAsURL()
InputStream	getInputStream() Get the input stream to read from the object.
InputStream	getInputStream(int nConnectTimeoutMS, int nReadTimeoutMS)
InputStream	getInputStream(int nConnectTimeoutMS, int nReadTimeoutMS, INonThrowingRunnableWithParameter<URLConnection> aConnectionModifier, IWrapper<IOException> aExceptionHolder)
InputStream	getInputStream(int nConnectTimeoutMS, int nReadTimeoutMS, IWrapper<IOException> aExceptionHolder)
InputStream	getInputStream(IWrapper<IOException> aExceptionHolder)
static InputStream	getInputStream(URL aURL)
String	getPath()
URLResource	getReadableCloneForPath(String sPath)
URLResource	getReadableCloneForPath(URL aURL)
Reader	getReader(Charset aCharset) Get an Reader based on this input stream provider using the given charset.
Reader	getReader(String sCharset) Deprecated.
String	getResourceID()
int	hashCode()
static boolean	isExplicitURLResource(String sName) Check if the passed resource name is an explicit URL resource.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PROTOCOL_FILE

public static final String PROTOCOL_FILE

The protocol for file resources

See Also:

Constant Field Values

DEFAULT_CONNECT_TIMEOUT

public static final int DEFAULT_CONNECT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_READ_TIMEOUT

public static final int DEFAULT_READ_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

URLResource

public URLResource(@Nonnull
           ISimpleURL aURL)
            throws MalformedURLException

Throws:

MalformedURLException

URLResource

public URLResource(@Nonnull
           String sURL)
            throws MalformedURLException

Throws:

MalformedURLException

URLResource

public URLResource(@Nonnull
           URI aURI)
            throws MalformedURLException

Throws:

MalformedURLException

URLResource

public URLResource(@Nonnull
           URL aURL)

Method Detail

isExplicitURLResource

public static boolean isExplicitURLResource(@Nullable
                            String sName)

Check if the passed resource name is an explicit URL resource.

Parameters:

sName - The name to check. May be null.

Returns:

true if the passed name is an explicit URL resource.

getResourceID

@Nonnull
public String getResourceID()

Specified by:

getResourceID in interface IResourceBase

Returns:

A non-null resource ID used e.g. for system IDs in XML resolving.

getPath

@Nonnull
public String getPath()

Specified by:

getPath in interface IResourceBase

Returns:

The requested path. Never null

getInputStream

@Nullable
public static InputStream getInputStream(@Nonnull
                                  URL aURL)

getInputStream

@Nullable
public InputStream getInputStream()

Description copied from interface: IInputStreamProvider

Get the input stream to read from the object. Each time this method is call, a new InputStream needs to be created!

Specified by:

getInputStream in interface IInputStreamProvider

Returns:

null if resolving failed.

getInputStream

@Nullable
public InputStream getInputStream(int nConnectTimeoutMS,
                                  int nReadTimeoutMS)

getInputStream

@Nullable
public InputStream getInputStream(@Nullable
                                  IWrapper<IOException> aExceptionHolder)

getInputStream

@Nullable
public InputStream getInputStream(int nConnectTimeoutMS,
                                  int nReadTimeoutMS,
                                  @Nullable
                                  IWrapper<IOException> aExceptionHolder)

getInputStream

@Nullable
public InputStream getInputStream(int nConnectTimeoutMS,
                                  int nReadTimeoutMS,
                                  @Nullable
                                  INonThrowingRunnableWithParameter<URLConnection> aConnectionModifier,
                                  @Nullable
                                  IWrapper<IOException> aExceptionHolder)

getReader

@Nullable
@Deprecated
public Reader getReader(@Nonnull
                                   String sCharset)

Deprecated.

Description copied from interface: IInputStreamAndReaderProvider

Get an Reader based on this input stream provider using the given charset.

Specified by:

getReader in interface IInputStreamAndReaderProvider

Parameters:

sCharset - The charset to use. May not be null.

Returns:

null if no input stream could be retrieved.

getReader

@Nullable
public Reader getReader(@Nonnull
                        Charset aCharset)

Description copied from interface: IInputStreamAndReaderProvider

Get an Reader based on this input stream provider using the given charset.

Specified by:

getReader in interface IInputStreamAndReaderProvider

Parameters:

aCharset - The charset to use. May not be null.

Returns:

null if no input stream could be retrieved.

exists

public boolean exists()

Specified by:

exists in interface IResourceBase

Returns:

true if the resource exists, false otherwise.

getAsURL

@Nonnull
public URL getAsURL()

Specified by:

getAsURL in interface IResourceBase

Returns:

the URL representation of this resource. May be null if this resource cannot be represented as an URL.

getAsURI

@Nullable
public URI getAsURI()

getAsFile

@Nonnull
public static File getAsFile(@Nonnull
                     URL aURL)

getAsFile

@Nonnull
public File getAsFile()

Specified by:

getAsFile in interface IResourceBase

Returns:

the File representation of this resource. May be null if this resource cannot be represented as a file.

getReadableCloneForPath

@Nonnull
public URLResource getReadableCloneForPath(@Nonnull
                                          URL aURL)

getReadableCloneForPath

@Nonnull
public URLResource getReadableCloneForPath(@Nonnull
                                          String sPath)

Specified by:

getReadableCloneForPath in interface IReadableResource

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object