com.perforce.api
Class RobotMessage

java.lang.Object
  com.perforce.api.RobotMessage

All Implemented Interfaces:

java.io.Serializable

Deprecated. This shoud be a part of the P4WebPublisher package.

public class RobotMessage
extends java.lang.Object
implements java.io.Serializable

Container class for messages to and from the P4Robot. This message is sent to the robot by the P4ReviewerService and any other application that wants to instruct the P4Robot to synchronize with the P4 depot in a particular way.

The key to this is the views that are a part of this. Each view will be used in executing "p4 sync" on the P4Robot. If the SYNC_FORCE flag is specified, then the views are all executed with "p4 sync -f". If the SYNC_ALL flag is specified, the views are ignored and one "p4 sync //..." is executed (with the -f flag, if that is also specified).

Version:

$Date: 2001/11/05 $ $Revision: #1 $

Author:

David Markley

See Also:

Serialized Form

Field Summary

static int	SYNC_ALL Deprecated. Indicates that the views should be ignored and "p4 sync //..." is run
static int	SYNC_FORCE Deprecated. Indicates that the "p4 sync" should be run with the -f option

Constructor Summary

RobotMessage()
Deprecated. Default no-argument constructor.

RobotMessage(Change change)
Deprecated. Constructs a RobotMessage using the specified Change.

Method Summary

void	addView(java.lang.String view) Deprecated. Add a view.
void	clearViews() Deprecated. Clear all view information.
int	getFlags() Deprecated. Returns the flags that are set.
int	getViewCount() Deprecated. Returns the number of views in this.
java.util.Enumeration	getViews() Deprecated. Returns an enumeration of the views.
void	setFlags(int flags) Deprecated. Sets the flags.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SYNC_FORCE

public static final int SYNC_FORCE

Deprecated.

Indicates that the "p4 sync" should be run with the -f option

See Also:

Constant Field Values

SYNC_ALL

public static final int SYNC_ALL

Deprecated.

Indicates that the views should be ignored and "p4 sync //..." is run

See Also:

Constant Field Values

Constructor Detail

RobotMessage

public RobotMessage()

Deprecated.

Default no-argument constructor.

RobotMessage

public RobotMessage(Change change)

Deprecated.

Constructs a RobotMessage using the specified Change. What this does is load the views for this with the files that were affected by the Change. This allows for a more focused sync on the robot side.

Parameters:

change - Change to be used in constructing this.

Method Detail

addView

public void addView(java.lang.String view)

Deprecated.

Add a view. The view will be appended to a "p4 sync" executed by the robot. Thus, any valid file specification that is valid with "p4 sync" can be used: file[revRange]

Parameters:

view - Single view to be added.

clearViews

public void clearViews()

Deprecated.

Clear all view information. This is useful, if the RobotMessage instance is to be reused in another send to a robot.

getViewCount

public int getViewCount()

Deprecated.

Returns the number of views in this.

getViews

public java.util.Enumeration getViews()

Deprecated.

Returns an enumeration of the views. This is most useful on the robot end of things.

setFlags

public void setFlags(int flags)

Deprecated.

Sets the flags.

Parameters:

flags - New value for the flags

See Also:

SYNC_FORCE, SYNC_ALL

getFlags

public int getFlags()

Deprecated.

Returns the flags that are set.

See Also:

SYNC_FORCE, SYNC_ALL