Nuxeo Enterprise Platform 5.4

org.nuxeo.connect.update.util
Class FileRef

java.lang.Object
  extended by org.nuxeo.connect.update.util.FileRef
Direct Known Subclasses:
FileRef.ExactFileRef

public abstract class FileRef
extends java.lang.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
static class FileRef.ExactFileRef
           
 
Constructor Summary
FileRef()
           
 
Method Summary
abstract  void fillPatternVariables(java.util.Map<java.lang.String,java.lang.Object> vars)
          Fill the given map with pattern variables.
abstract  java.io.File getFile()
          Get the file referenced by this object.
abstract  boolean hasPattern()
          Whether the referred file has a name pattern
static FileRef newFileRef(java.io.File file)
           
static FileRef newFileRef(java.lang.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(java.lang.String path)

newFileRef

public static FileRef newFileRef(java.io.File file)

getFile

public abstract java.io.File getFile()
Get 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

Returns:

fillPatternVariables

public abstract void fillPatternVariables(java.util.Map<java.lang.String,java.lang.Object> vars)
Fill the given map with pattern variables.

Parameters:
vars -

Nuxeo Enterprise Platform 5.4

Copyright © 2010 Nuxeo SAS. All Rights Reserved.