Package eu.bandm.tools.util.files

Class SourceHabitats.SourceHabitat_resource

java.lang.Object

eu.bandm.tools.util.files.SourceHabitats.SourceHabitat

eu.bandm.tools.util.files.SourceHabitats.SourceHabitat_resource

Enclosing class:

SourceHabitats

protected class SourceHabitats.SourceHabitat_resource
extends SourceHabitats.SourceHabitat

Represents a source habitat which points to a directory, relative to the position of a loaded java class. So the name must be like a.b.c or a.b.c/d/e, see SourceHabitats.SourceHabitat. All resources searched for must be files existing relative to the point where the class has been loaded from (e.g. file system, or a ".jar" file) and this accessible by Class.getResourceAsStream(String) or sim.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) @Opt Class<?>	cls	Startpoint of the resources represented by this habitat.
protected final String	reldir	Directory relative to cls which serves as startpoint for searchign resources.

Fields inherited from class eu.bandm.tools.util.files.SourceHabitats.SourceHabitat

name, ok

Constructor Summary

Constructors

Constructor	Description
SourceHabitat_resource(String name)	Only constructor.

Method Summary

Modifier and Type	Method	Description
protected @Opt SourceHabitats.FoundSource	test_idExt(String id, BiConsumer<String,Object[]> verbose, String ext)	Searches for the resource with the given name and suffix.

Methods inherited from class eu.bandm.tools.util.files.SourceHabitats.SourceHabitat

test_for_inputStream

Methods inherited from class java.lang.Object

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

Field Details

cls

@Opt
@Opt Class<?> cls

Startpoint of the resources represented by this habitat. ==null only in case of error.

reldir

protected final String reldir

Directory relative to cls which serves as startpoint for searchign resources.

Constructor Details

SourceHabitat_resource

public SourceHabitat_resource(String name)

Only constructor.

Parameters:

name - defines the start point where to look for sources, see SourceHabitats.SourceHabitat.

Method Details

test_idExt

@Opt
protected @Opt SourceHabitats.FoundSource test_idExt(String id,
 BiConsumer<String,Object[]> verbose,
 String ext)

Description copied from class: SourceHabitats.SourceHabitat

Searches for the resource with the given name and suffix. This must be implemented differently for different kinds of Habitats. Fills in the found stream and "location" into the a SourceHabitats.FoundSource object.

Specified by:

test_idExt in class SourceHabitats.SourceHabitat

Parameters:

id - name of the resource searched for

verbose - the target of log messages

ext - extension of the resource name / file name. It must include the leading dot (=".") or be completely empty.

Returns:

the found resource or null if no such exists.