Inheritance diagram for de.fu_berlin.inf.dpp.activities.FileActivity:

Public Types
enum	Purpose { ACTIVITY, RECOVERY }
enum	Type { CREATED, REMOVED, MOVED }
Public Member Functions
	FileActivity (User source, Type type, SPath newPath, SPath oldPath, byte[] content, String encoding, Purpose purpose)
boolean	isValid ()
SPath	getOldPath ()
Type	getType ()
byte[]	getContent ()
String	getEncoding ()
String	toString ()
int	hashCode ()
boolean	equals (Object obj)
void	dispatch (IActivityReceiver receiver)
boolean	isRecovery ()
Static Public Member Functions
static FileActivity	created (User source, SPath path, byte[] content, String encoding, Purpose purpose)
static FileActivity	moved (User source, SPath destPath, SPath sourcePath, byte[] content, String encoding)
static FileActivity	removed (User source, SPath path, Purpose purpose)
Protected Attributes
final SPath	oldPath
final Type	type
final Purpose	purpose
String	encoding
final byte[]	content

Member Enumeration Documentation

Enumeration used to distinguish file activities which are caused as part of a consistency recovery and those used as regular activities.

Enumerator:

ACTIVITY
RECOVERY

Enumerator:

CREATED	The file was created or modified, but the path stayed the same.
REMOVED	The file was deleted.
MOVED	The path of the file changed. The content might have changed, too.

Constructor & Destructor Documentation

de.fu_berlin.inf.dpp.activities.FileActivity.FileActivity	(	User	source,
		Type	type,
		SPath	newPath,
		SPath	oldPath,
		byte[]	content,
		String	encoding,
		Purpose	purpose
	)

Generic constructor for FileActivitys

Parameters:

source	the user who is the source (originator) of this Activity
newPath	where to save the data (if Type#CREATED), destination of a move (if Type#MOVED), file to remove (if Type#REMOVED); never `null`
oldPath	if type is Type#MOVED, the path from where the file was moved (`null` otherwise)
content	content of the file denoted by the path (only valid for Type#CREATED and Type#MOVED)
encoding	the encoding the content is encoded with or `null`

static FileActivity de.fu_berlin.inf.dpp.activities.FileActivity.created	(	User	source,
		SPath	path,
		byte[]	content,
		String	encoding,
		Purpose	purpose
	)		`[static]`

Utility method for creating a FileActivity of type Type#CREATED for a given path.

Parameters:

path	path referencing the newly created file
content	content of the file denoted by the path
encoding	the encoding the content is encoded with or `null`

void de.fu_berlin.inf.dpp.activities.FileActivity.dispatch ( IActivityReceiver receiver )

boolean de.fu_berlin.inf.dpp.activities.FileActivity.equals ( Object obj )

byte [] de.fu_berlin.inf.dpp.activities.FileActivity.getContent ( )

Important: the content of the array must not be changed

See also:: created(User, SPath, byte[], String, Purpose); moved(User, SPath, SPath, byte[], String)

String de.fu_berlin.inf.dpp.activities.FileActivity.getEncoding ( )

Returns the encoding the content is encoded with.

SPath de.fu_berlin.inf.dpp.activities.FileActivity.getOldPath ( )

Returns the old/source path in case this Activity represents a moving of files.

Type de.fu_berlin.inf.dpp.activities.FileActivity.getType ( )

int de.fu_berlin.inf.dpp.activities.FileActivity.hashCode ( )

boolean de.fu_berlin.inf.dpp.activities.FileActivity.isRecovery ( )

boolean de.fu_berlin.inf.dpp.activities.FileActivity.isValid ( )

static FileActivity de.fu_berlin.inf.dpp.activities.FileActivity.moved	(	User	source,
		SPath	destPath,
		SPath	sourcePath,
		byte[]	content,
		String	encoding
	)		`[static]`

Builder for moving files (type Type#MOVED).

Parameters:

source	JID of the origin user
destPath	path where the file moved to
sourcePath	path where the file moved from
content	content of the file denoted by the path, may be `null` to indicate that the file content was not changed when moved
encoding	the encoding the content is encoded with or `null`