org.eclipse.ptp.rdt.sync.core
Enum SyncFlag

java.lang.Object
  java.lang.Enum<SyncFlag>
      org.eclipse.ptp.rdt.sync.core.SyncFlag

All Implemented Interfaces:

Serializable, Comparable<SyncFlag>

public enum SyncFlag
extends Enum<SyncFlag>

Flags to control the behavior of synchronization. Currently, the individual FORCE_SYNC_TO_LOCAL and FORCE_SYNC_TO_REMOTE flags are not used. Instead, the EnumSets are used as defined below. Please note that the synchronization protocol is a work in progress, and the meanings of these flags are subject to change.

Since:

3.0

Enum Constant Summary

DISABLE_SYNC

FORCE_SYNC_TO_LOCAL

FORCE_SYNC_TO_REMOTE

Field Summary

static EnumSet<SyncFlag>	FORCE Force transferring of files.
static EnumSet<SyncFlag>	NO_FORCE Transfer files "if needed".
static EnumSet<SyncFlag>	NO_SYNC Do not actually transfer files.

Method Summary

static SyncFlag	valueOf(String name) Returns the enum constant of this type with the specified name.
static SyncFlag[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DISABLE_SYNC

public static final SyncFlag DISABLE_SYNC

FORCE_SYNC_TO_LOCAL

public static final SyncFlag FORCE_SYNC_TO_LOCAL

FORCE_SYNC_TO_REMOTE

public static final SyncFlag FORCE_SYNC_TO_REMOTE

Field Detail

NO_SYNC

public static final EnumSet<SyncFlag> NO_SYNC

Do not actually transfer files. Just do any necessary bookkeeping. (This is used, for example, when files change on the system, but the user has disabled sync'ing.)

NO_FORCE

public static final EnumSet<SyncFlag> NO_FORCE

Transfer files "if needed". For example, if a resource change has affected the local repository. (The meaning of "if needed" is subject to change.

FORCE

public static final EnumSet<SyncFlag> FORCE

Force transferring of files. This could be necessary, for example, to download remote changes.

Method Detail

values

public static SyncFlag[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SyncFlag c : SyncFlag.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SyncFlag 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

NullPointerException - if the argument is null