com.helger.commons.io.resourceprovider

Class ClassPathResourceProvider

java.lang.Object

com.helger.commons.io.resourceprovider.ClassPathResourceProvider

All Implemented Interfaces:

IReadableResourceProvider

@Immutable
public final class ClassPathResourceProvider
extends Object
implements IReadableResourceProvider

Simple resource provider that only uses files.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
ClassPathResourceProvider() Constructor without prefix.
ClassPathResourceProvider(String sPrefix) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getPrefix()
IReadableResource	getReadableResource(String sName) Get the resource specified by the given name for reading.
int	hashCode()
boolean	supportsReading(String sName) Check if this resource provider can handle the resource with the passed name.
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.resourceprovider.IReadableResourceProvider

getInputStream

Constructor Detail

ClassPathResourceProvider

public ClassPathResourceProvider()

Constructor without prefix.

ClassPathResourceProvider

public ClassPathResourceProvider(@Nullable
                                 String sPrefix)

Constructor

Parameters:

sPrefix - The common prefix to use. May be null.

Method Detail

getPrefix

@Nullable
public String getPrefix()

Returns:

The prefix as passed in the constructor. May be null.

supportsReading

public boolean supportsReading(@Nullable
                               String sName)

Description copied from interface: IReadableResourceProvider

Check if this resource provider can handle the resource with the passed name. If there is no real check on whether your resource provider can handle it, simply return true.

Specified by:

supportsReading in interface IReadableResourceProvider

Parameters:

sName - The name to check. May be null.

Returns:

true if the name is not null and can be handled by this provider, false otherwise.

getReadableResource

@Nonnull
public IReadableResource getReadableResource(@Nonnull
                                                       String sName)

Description copied from interface: IReadableResourceProvider

Get the resource specified by the given name for reading.

Specified by:

getReadableResource in interface IReadableResourceProvider

Parameters:

sName - The name of the resource to resolve.

Returns:

The readable resource. Never 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