FileRef.PatternFileRef (Nuxeo 2021.53.3 API Documentation)

java.lang.Object
- org.nuxeo.common.utils.FileRef
- - org.nuxeo.common.utils.FileRef.PatternFileRef

Enclosing class:: FileRef

public static class FileRef.PatternFileRef
extends FileRef

Nested Class Summary
- Nested classes/interfaces inherited from class org.nuxeo.common.utils.FileRef
  FileRef.ExactFileRef, FileRef.PatternFileRef

Field Summary

Fields
Modifier and Type Field Description

protected File file

protected String key

protected String value

Constructor Summary

Constructors
Constructor Description

PatternFileRef(File file)

PatternFileRef(String path)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`fillPatternVariables(Map<String,Object> vars)`	Fill the given map with pattern variables.
`File`	`getFile()`	Gets the file referenced by this object.
`String`	`getKey()`
`String`	`getValue()`
`boolean`	`hasPattern()`	Whether the referred file has a name pattern.

Methods inherited from class org.nuxeo.common.utils.FileRef
newFileRef, newFileRef

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - file
```
protected File file
```
  - key
```
protected String key
```
  - value
```
protected String value
```
- Constructor Detail
  - PatternFileRef
```
public PatternFileRef(String path)
```
  - PatternFileRef
```
public PatternFileRef(File file)
```
- Method Detail
  - getFile
```
public File getFile()
```
    Description copied from class: FileRef
    
    Gets the file referenced by this object. If the FileRef could not be resolved then null is returned.
    
    Specified by:
    
    getFile in class FileRef
    
    Returns:
    
    the referred file or null if none was found.
  - getValue
```
public String getValue()
```
  - getKey
```
public String getKey()
```
  - hasPattern
```
public boolean hasPattern()
```
    Description copied from class: FileRef
    
    Whether the referred file has a name pattern.
    
    Specified by:
    
    hasPattern in class FileRef
  - fillPatternVariables
```
public void fillPatternVariables(Map<String,Object> vars)
```
    Description copied from class: FileRef
    
    Fill the given map with pattern variables.
    
    Specified by:
    
    fillPatternVariables in class FileRef