com.helger.commons.io.resource.inmemory

Class AbstractMemoryReadableResource

java.lang.Object

com.helger.commons.io.resource.inmemory.AbstractMemoryReadableResource

All Implemented Interfaces:

IHasInputStream, IHasInputStreamAndReader, IMemoryReadableResource, IReadableResource, IResourceBase

Direct Known Subclasses:

ReadableResourceByteArray, ReadableResourceInputStream

public abstract class AbstractMemoryReadableResource
extends Object
implements IMemoryReadableResource

Abstract base class for an IReadableResource that is not really a resource but where the API does not offer alternatives. These resources cannot be converted to a file or to a URL.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
AbstractMemoryReadableResource(String sResourceID) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	exists()
File	getAsFile()
URL	getAsURL()
String	getPath()
IReadableResource	getReadableCloneForPath(String sPath) Get a new resource of the same implementation type as this object but for a different path.
String	getResourceID()
String	toString()

Methods inherited from class java.lang.Object

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

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

getBufferedReader, getReader

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

getBufferedInputStream, getInputStream, isReadMultiple

Constructor Detail

AbstractMemoryReadableResource

public AbstractMemoryReadableResource(@Nonnull @Nonempty
                                      String sResourceID)

Constructor.

Parameters:

sResourceID - The mandatory resource ID, used as the cache key. May neither be null nor empty.

Method Detail

getResourceID

@Nonnull
 @Nonempty
public final String getResourceID()

Specified by:

getResourceID in interface IResourceBase

Returns:

The resource ID as provided in the constructor. Neither null nor empty.

getPath

@Nonnull
public String getPath()

Specified by:

getPath in interface IResourceBase

Returns:

The requested path. Never null

getAsURL

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

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.

exists

public boolean exists()

Specified by:

exists in interface IResourceBase

Returns:

true if the resource exists, false otherwise.

getReadableCloneForPath

@Nonnull
 @UnsupportedOperation
public IReadableResource 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.

toString

public String toString()

Overrides:

toString in class Object