public class DeepRename extends XMLRequest
Modifier and Type | Class and Description |
---|---|
static class |
DeepRename.AbortIfNameExistsMode
AbortIfNameExistsMode.
|
static class |
DeepRename.IncludeFolderNamesMode
ChangeFolderNameMode.
|
Constructor and Description |
---|
DeepRename()
Constructs a
DeepRename request. |
Modifier and Type | Method and Description |
---|---|
void |
setAbortIfNameExists(DeepRename.AbortIfNameExistsMode nameExistsMode)
Sets the mode for abortIfNameExists.
|
void |
setCleanPattern(java.lang.String cleanPattern)
Sets the new name.
|
void |
setIncludeFolderNames(DeepRename.IncludeFolderNamesMode includeFolderNamesMode)
Sets the mode for includeFolderNames.
|
void |
setNamePattern(java.lang.String namePattern)
Sets the name pattern of the object to rename.
|
getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send
public void setNamePattern(java.lang.String namePattern)
namePattern
- wildcard with exactly one '*': like "BEGIN.*.END"
new object names will be created like "BEGIN.NAME.END
pattern must contain a '*', strings before/after the '*' are optionalpublic void setCleanPattern(java.lang.String cleanPattern)
cleanPattern
- wildcard with exactly one '*': like "BEFORE.*.AFTER"
old object names are used to create new object names using parameter namePattern, however,
cleanPatter is used to remove leading and/or trailing characters.
in this example, prefix/postfix "BEFORE." / ".AFTER" is removed from the begin / end of old names and
"BEGIN_" / "_END" is used as new prefix / postfix to create the new name,
e.g., old name "BEFORE.NAME.AFTER" is converted to new name "BEGIN.NAME.END"
pattern must contain a '*', strings before/after the '*' are optionalpublic void setAbortIfNameExists(DeepRename.AbortIfNameExistsMode nameExistsMode)
nameExistsMode
- One of the AbortIfNameExistsMode
defined in this classpublic void setIncludeFolderNames(DeepRename.IncludeFolderNamesMode includeFolderNamesMode)
includeFolderNamesMode
- One of the IncludeFolderNamesMode
defined in this class