public class RootPath extends AnchorBean<RootPath>
This a directory in which files are read/written during analysis.
Analysis scripts may select different root-paths depending on how they are executed (e.g. locally writing to the filesystem during debugging on a single-file, but to a server for many files).
The name of a root must not be unique, but the combination of all fields should be unique i.e. several roots can have the same name, but should vary in their other settings.
Constructor and Description |
---|
RootPath() |
Modifier and Type | Method and Description |
---|---|
Path |
asPath()
Exposes the
path field as a Path . |
protected boolean |
canEqual(Object other) |
boolean |
equals(Object o) |
String |
getName()
The name of the root-path, which need not be unique in itself.
|
String |
getPath()
A path on a file-system to the directory, that defines the root.
|
int |
hashCode() |
boolean |
isDebug()
If true this root is preferred, when executing a job in debugging mode.
|
void |
setDebug(boolean debug)
If true this root is preferred, when executing a job in debugging mode.
|
void |
setName(String name)
The name of the root-path, which need not be unique in itself.
|
void |
setPath(String path)
A path on a file-system to the directory, that defines the root.
|
SplitPath |
split(Path path)
It splits the root portion of a path from the remainder.
|
checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString
public SplitPath split(Path path) throws PathDifferenceException
path
- path to split.PathDifferenceException
- if the path cannot be matched against the root.protected boolean canEqual(Object other)
public String getName()
public void setName(String name)
public String getPath()
public void setPath(String path)
public boolean isDebug()
public void setDebug(boolean debug)
Copyright © 2010–2023 Owen Feehan, ETH Zurich, University of Zurich, Hoffmann-La Roche. All rights reserved.