Package eu.bandm.tools.util.files

Class SourceHabitats

java.lang.Object

eu.bandm.tools.util.files.SourceHabitats

public class SourceHabitats
extends Object

Organizes a collection of places where to look for resources (=input files).
A sequence of SourceHabitats.SourceHabitat is maintained which will be searched for a file, ie. a data source with a certain file name. Currently this can be a SourceHabitats.SourceHabitat_file as a pointer into the file system, or a SourceHabitats.SourceHabitat_resource as a class which cames with "resources", eg. in a ".jar" file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	SourceHabitats.FoundSource	Represents the only one data source which has been successfully found for one particular resource name (mostly a "file name stem").
class	SourceHabitats.SourceHabitat	Represents one of many potential sources which have to be searched for library modules, etc.
protected class	SourceHabitats.SourceHabitat_file	Represents a source habitat which is a directory in the file system.
protected class	SourceHabitats.SourceHabitat_resource	Represents a source habitat which points to a directory, relative to the position of a loaded java class.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final BiConsumer<String,Object[]>	msg
static final String	PREFIX_FILE
static final String	PREFIX_RESOURCE
static final String	RELATIVE_PATH_SEPARATOR
protected List<SourceHabitats.SourceHabitat>	sourceList

Constructor Summary

Constructors

Constructor	Description
SourceHabitats(BiConsumer<String,Object[]> msg)

Method Summary

Modifier and Type	Method	Description
String	allPlaces_toString()
void	appendNewHabitat(String s, @Opt String additionalErrorText)	Service access point for adding a habitat to the end of the search list.
protected void	ERROR(String txt, Object... args)
protected @Opt SourceHabitats.SourceHabitat	makeHabitat(String name, @Opt String additionalErrorText)	Internal method to check whether the input to appendNewHabitat(String,String) is consistent.
@Opt SourceHabitats.FoundSource	searchAllPlaces(String name, @Opt BiConsumer<String,Object[]> verbose, String... suffices)	Service access point for searching all habitats, for the name of the resources, tested with all suffixed.

Methods inherited from class java.lang.Object

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

Field Details

PREFIX_FILE

public static final String PREFIX_FILE

See Also:

• Constant Field Values

PREFIX_RESOURCE

public static final String PREFIX_RESOURCE

See Also:

• Constant Field Values

RELATIVE_PATH_SEPARATOR

public static final String RELATIVE_PATH_SEPARATOR

See Also:

• Constant Field Values

msg

final BiConsumer<String,Object[]> msg

sourceList

protected List<SourceHabitats.SourceHabitat> sourceList

Constructor Details

SourceHabitats

public SourceHabitats(BiConsumer<String,Object[]> msg)

Method Details

allPlaces_toString

public String allPlaces_toString()

searchAllPlaces

@Opt
public @Opt SourceHabitats.FoundSource searchAllPlaces(String name,
 @Opt
 @Opt BiConsumer<String,Object[]> verbose,
 String... suffices)

Service access point for searching all habitats, for the name of the resources, tested with all suffixed. The suffixes are tested faster, i.e.all are tested per habitat in the sequential order of the argument. The suffixes must include a leading dot (="."), but can also be totally empty.

appendNewHabitat

public void appendNewHabitat(String s,
 @Opt
 @Opt String additionalErrorText)

Service access point for adding a habitat to the end of the search list. Does so only if consistency checks okay.

Parameters:

s - name of the habitat according to the defined prefices, see class docu text.

additionalErrorText - describes the context of the habitat modification attempt

ERROR

protected void ERROR(String txt,
 Object... args)

makeHabitat

@Opt
protected @Opt SourceHabitats.SourceHabitat makeHabitat(String name,
 @Opt
 @Opt String additionalErrorText)

Internal method to check whether the input to appendNewHabitat(String,String) is consistent.

Parameters:

additionalErrorText - describes the context of the habitat modification attempt