org.nuxeo.common.utils

Class FileRef

java.lang.Object

org.nuxeo.common.utils.FileRef

Direct Known Subclasses:

FileRef.ExactFileRef, FileRef.PatternFileRef

public abstract class FileRef
extends Object

A file reference that can handle file name patterns. A file pattern can use named variable that will be substituted with the actual value of the file that matched the pattern.

Example: For a file pattern nuxeo-automation-core-{v:.*}.jar that will match a file named nuxeo-automation-core-5.3.2.jar the pattern variable will be v=5.3.2.

Note that only one pattern variable is supported.

Author:

Bogdan Stefanescu

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileRef.ExactFileRef
static class	FileRef.PatternFileRef

Constructor Summary

Constructors

Constructor and Description
FileRef()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	fillPatternVariables(Map<String,Object> vars) Fill the given map with pattern variables.
abstract File	getFile() Gets the file referenced by this object.
abstract boolean	hasPattern() Whether the referred file has a name pattern.
static FileRef	newFileRef(File file)
static FileRef	newFileRef(String path)

Methods inherited from class java.lang.Object

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

Constructor Detail

FileRef

public FileRef()

Method Detail

newFileRef

public static FileRef newFileRef(String path)

newFileRef

public static FileRef newFileRef(File file)

getFile

public abstract File getFile()

Gets the file referenced by this object. If the FileRef could not be resolved then null is returned.

Returns:

the referred file or null if none was found.

hasPattern

public abstract boolean hasPattern()

Whether the referred file has a name pattern.

fillPatternVariables

public abstract void fillPatternVariables(Map<String,Object> vars)

Fill the given map with pattern variables.