public class FileCreateInfo extends AbstractCreateInfo
The following table illustrates the use of the overwrite
and enableVersioning
flags and how they
effect the outcome when there is or is not an existing file at the location specified. The red background indicates
the flag has no effect on the combination of factors, the green means it is directly related to the results.
file existence | overwrite | enableVersioning | results |
---|---|---|---|
no file | FALSE | FALSE | New un-versioned file created |
FALSE | TRUE | New versioned file created | |
TRUE | FALSE | New un-versioned file created | |
TRUE | TRUE | New versioned file created | |
un-versioned file exists | FALSE | FALSE | Exists exception |
FALSE | TRUE | Exists exception | |
TRUE | FALSE | File content updated in place | |
TRUE | TRUE | File content updated in place | |
versioned file exists | FALSE | FALSE | New version created |
FALSE | TRUE | New version created | |
TRUE | FALSE | New version created | |
TRUE | TRUE | New version created |
Constructor and Description |
---|
FileCreateInfo(String path) |
FileCreateInfo(String parentPath,
String name) |
Modifier and Type | Method and Description |
---|---|
FileCreateInfo |
comment(String comment) |
FileCreateInfo |
customVersion(String customVersion) |
FileCreateInfo |
description(String description) |
FileCreateInfo |
enableVersioning() |
FileCreateInfo |
enableVersioning(boolean enableVersioning) |
String |
getComment() |
String |
getCustomVersion() |
VersionType |
getVersionType() |
boolean |
isEnableVersioning() |
boolean |
isOverwrite() |
FileCreateInfo |
overwrite() |
FileCreateInfo |
overwrite(boolean overwrite) |
void |
setComment(String comment) |
void |
setCustomVersion(String customVersion) |
void |
setEnableVersioning(boolean enableVersioning) |
void |
setOverwrite(boolean overwrite) |
void |
setVersionType(VersionType versionType) |
FileCreateInfo |
versionType(VersionType versionType) |
getDescription, getPath, setDescription
public FileCreateInfo(String path)
public String getComment()
public void setComment(String comment)
public boolean isEnableVersioning()
public void setEnableVersioning(boolean enableVersioning)
public boolean isOverwrite()
public void setOverwrite(boolean overwrite)
public VersionType getVersionType()
public void setVersionType(VersionType versionType)
public String getCustomVersion()
public void setCustomVersion(String customVersion)
public FileCreateInfo comment(String comment)
public FileCreateInfo enableVersioning()
public FileCreateInfo enableVersioning(boolean enableVersioning)
public FileCreateInfo customVersion(String customVersion)
public FileCreateInfo overwrite()
public FileCreateInfo overwrite(boolean overwrite)
public FileCreateInfo versionType(VersionType versionType)
public FileCreateInfo description(String description)
description
in class AbstractCreateInfo
<i>Copyright (c) 2022, SAS Institute Inc., Cary, NC, USA</i>