Modifier and Type | Field and Description |
---|---|
static FsFile |
emptyPath
the FsFile that has no path components
|
static char |
separatorChar
the separator character for delimiting repository path components
|
Constructor and Description |
---|
FsFile(Collection<String> components)
Construct an instance.
|
FsFile(File file)
Construct an instance.
|
FsFile(FsFile file,
int maxComponentCount)
Construct an instance by trimming parent directories from an existing instance
such that the depth does not exceed the given maximum.
|
FsFile(String... components)
Construct an instance.
|
FsFile(String path)
Construct an instance.
|
Modifier and Type | Method and Description |
---|---|
static FsFile |
concatenate(FsFile... files)
Concatenate paths.
|
boolean |
equals(Object object)
Instances are equal if their string representations match.
|
List<String> |
getComponents()
Get the path components of this instance.
|
FsFile |
getPathFrom(FsFile file)
Find the relative path of this path from a given parent.
|
int |
hashCode() |
File |
toFile(File file)
|
String |
toString()
Provides repository path with components separated by
separatorChar . |
FsFile |
transform(com.google.common.base.Function<String,String> componentTransformer)
Transform each path component with the given transformer.
|
public static char separatorChar
public static FsFile emptyPath
public FsFile(Collection<String> components)
components
- the components of the path to which this instance corresponds, may be nullpublic FsFile(String... components)
components
- the components of the path to which this instance correspondspublic FsFile(FsFile file, int maxComponentCount)
file
- an existing instancemaxComponentCount
- the number of child components of the instance,
including filename, above which parents should be ignoredpublic FsFile(File file)
file
- the file to whose absolute path this instance correspondspublic FsFile(String path)
path
- the path that this instance's string representation must matchpublic FsFile transform(com.google.common.base.Function<String,String> componentTransformer)
componentTransformer
- a transformerpublic FsFile getPathFrom(FsFile file)
file
- a parent path (may be the same as this one)public static FsFile concatenate(FsFile... files)
files
- the paths to concatenatepublic List<String> getComponents()
public File toFile(File file)
file
- parent directory, may be null for a relative return value,
but actually expected to be the repository's root directorypublic String toString()
separatorChar
.
Suitable for displaying to the user and for constructing a new instance.public boolean equals(Object object)
Version: 5.3.5-ice35-b73
Copyright © 2017 The University of Dundee & Open Microscopy Environment. All Rights Reserved.