Package com.helger.commons.io.resource

Class URLResource

java.lang.Object

com.helger.commons.io.resource.URLResource

All Implemented Interfaces:

IHasInputStream, IHasInputStreamAndReader, IReadableResource, IResourceBase

@Immutable
public class URLResource
extends Object
implements IReadableResource

Implementation of the IReadableResource interface for URL objects.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_CONNECT_TIMEOUT
static int	DEFAULT_READ_TIMEOUT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
boolean	exists()
File	getAsFile()
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, IMutableWrapper<IOException> aExceptionHolder)
InputStream	getInputStream(int nConnectTimeoutMS, int nReadTimeoutMS, Consumer<? super URLConnection> aConnectionModifier, IMutableWrapper<IOException> aExceptionHolder)
InputStream	getInputStream(IMutableWrapper<IOException> aExceptionHolder)
static InputStream	getInputStream(URL aURL)
String	getPath()
URLResource	getReadableCloneForPath(String sPath)	Get a new resource of the same implementation type as this object but for a different path.
URLResource	getReadableCloneForPath(URL aURL)
String	getResourceID()
int	hashCode()
static boolean	isExplicitURLResource(String sName)	Check if the passed resource name is an explicit URL resource.
boolean	isReadMultiple()	Check if the InputStream from IHasInputStream.getInputStream() and IHasInputStream.getBufferedInputStream() can be acquired more than once.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.io.IHasInputStream

getBufferedInputStream

Methods inherited from interface com.helger.commons.io.IHasInputStreamAndReader

getBufferedReader, getReader

Field Detail

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: IHasInputStream

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

Specified by:

getInputStream in interface IHasInputStream

Returns:

null if resolving failed.

getInputStream

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

getInputStream

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

getInputStream

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

getInputStream

@Nullable
public InputStream getInputStream(@CheckForSigned
                                  int nConnectTimeoutMS,
                                  @CheckForSigned
                                  int nReadTimeoutMS,
                                  @Nullable
                                  Consumer<? super URLConnection> aConnectionModifier,
                                  @Nullable
                                  IMutableWrapper<IOException> aExceptionHolder)

isReadMultiple

public final boolean isReadMultiple()

Description copied from interface: IHasInputStream

Check if the InputStream from IHasInputStream.getInputStream() and IHasInputStream.getBufferedInputStream() can be acquired more than once.

Specified by:

isReadMultiple in interface IHasInputStream

Returns:

true if the input stream can be acquired more than once, false if not.

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

@Nullable
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)

Description copied from interface: IReadableResource

Get a new resource of the same implementation type as this object but for a different path.

Specified by:

getReadableCloneForPath in interface IReadableResource

Parameters:

sPath - The new path to use. May not be null.

Returns:

The resource of the same implementation but a different path. May not be null.

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