Project: stp

com.ibm.rational.wvcm.stp.cq
Enum CqQueryFolderItem.OverwriteMode

Object
  extended by Enum<CqQueryFolderItem.OverwriteMode>
      extended by CqQueryFolderItem.OverwriteMode
All Implemented Interfaces:
Serializable, Comparable<CqQueryFolderItem.OverwriteMode>
Enclosing interface:
CqQueryFolderItem

public static enum CqQueryFolderItem.OverwriteMode
extends Enum<CqQueryFolderItem.OverwriteMode>

An enumeration of the values for specifying what doCopy and/or doMove should do when a resource already exists at the targeted destination.


Enum Constant Summary
FORBID
          If a resource exists at the target location, the operation will fail; the resource at the target location will not be overwritten.
MERGE
          If the source resource is a folder and a folder exists at the target location, that folder is not deleted, but the contents of the source folder are merged with the contents of the target folder and this rule is applied recursively for each member of the source folder.
REPLACE
          If a resource exists at the target location, that resource is to be deleted and replaced by the source resource.
 
Method Summary
static CqQueryFolderItem.OverwriteMode valueOf(String name)
          Returns the enum constant of this type with the specified name.
static CqQueryFolderItem.OverwriteMode[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

FORBID

public static final CqQueryFolderItem.OverwriteMode FORBID
If a resource exists at the target location, the operation will fail; the resource at the target location will not be overwritten.


MERGE

public static final CqQueryFolderItem.OverwriteMode MERGE
If the source resource is a folder and a folder exists at the target location, that folder is not deleted, but the contents of the source folder are merged with the contents of the target folder and this rule is applied recursively for each member of the source folder. If either the source resource or the target resource is not a folder, the target resource is deleted and replaced by the source--i.e., in this case, the operation behaves the same as in the REPLACE OverwriteMode.


REPLACE

public static final CqQueryFolderItem.OverwriteMode REPLACE
If a resource exists at the target location, that resource is to be deleted and replaced by the source resource. Specifically, if the target is a folder, that folder and all of its members are deleted and replaced by the source.

Method Detail

valueOf

public static CqQueryFolderItem.OverwriteMode valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name

values

public static final CqQueryFolderItem.OverwriteMode[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(CqQueryFolderItem.OverwriteMode c : CqQueryFolderItem.OverwriteMode.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

Generated Mon 2-Mar-2009 11:14 PM

Copyright © IBM 2009. All rights reserved.