jadex.bridge.service.types.chat

Class TransferInfo

java.lang.Object

jadex.bridge.service.types.chat.TransferInfo

public class TransferInfo
extends Object

Information about a requested, ongoing or completed file transfer.

Field Summary

Fields

Modifier and Type	Field and Description
static String	STATE_ABORTED State when transfer was aborted by sending or receiving user.
static String	STATE_CANCELLING State when cancel was requested.
static String	STATE_COMPLETED State when transfer was successful.
static String	STATE_ERROR State when transfer was stopped due to e.g. network error.
static String	STATE_REJECTED State when transfer was rejected by receiver.
static String	STATE_TRANSFERRING State when transfer is in progress.
static String	STATE_WAITING State waiting for acceptance.

Constructor Summary

Constructors

Constructor and Description
TransferInfo() Create a new file transfer info.
TransferInfo(boolean download, String id, String filename, String filepath, IComponentIdentifier other, long size, long timeout) Create a new file transfer info.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for equality.
long	getDone() Get the done.
String	getFileName() Get the name of the local file (without path).
String	getFilePath() Get the full path of the local file (including filename).
String	getId() Get the id.
IComponentIdentifier	getOther() Get the opposite component.
long	getSize() Get the size.
double	getSpeed() Get the speed.
String	getState() Get the state.
long	getTimeout() Get the timeout.
int	hashCode() Get the hash code.
boolean	isDownload() Check if transfer is a download or upload.
boolean	isFinished() Check if transfer is finished.
void	setDone(long done) Set the done.
void	setDownload(boolean download) Set the transfer as a download or upload.
void	setFileName(String filename) Set the name of the local file (without path).
void	setFilePath(String filepath) Set the full path of the local file (including filename).
void	setId(String id) Set the id.
void	setOther(IComponentIdentifier other) Set the opposite component.
void	setSize(long size) Set the size.
void	setSpeed(double speed) Set the speed.
void	setState(String state) Set the state.
void	setTimeout(long timeout) Set the timeout.
boolean	update(long done) Update the transfer info.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

STATE_WAITING

public static final String STATE_WAITING

State waiting for acceptance.

See Also:

Constant Field Values

STATE_REJECTED

public static final String STATE_REJECTED

State when transfer was rejected by receiver.

See Also:

Constant Field Values

STATE_TRANSFERRING

public static final String STATE_TRANSFERRING

State when transfer is in progress.

See Also:

Constant Field Values

STATE_CANCELLING

public static final String STATE_CANCELLING

State when cancel was requested.

See Also:

Constant Field Values

STATE_COMPLETED

public static final String STATE_COMPLETED

State when transfer was successful.

See Also:

Constant Field Values

STATE_ABORTED

public static final String STATE_ABORTED

State when transfer was aborted by sending or receiving user.

See Also:

Constant Field Values

STATE_ERROR

public static final String STATE_ERROR

State when transfer was stopped due to e.g. network error.

See Also:

Constant Field Values

Constructor Detail

TransferInfo

public TransferInfo()

Create a new file transfer info.

TransferInfo

public TransferInfo(boolean download,
            String id,
            String filename,
            String filepath,
            IComponentIdentifier other,
            long size,
            long timeout)

Create a new file transfer info.

Method Detail

getFileName

public String getFileName()

Get the name of the local file (without path).

Returns:

the file name.

setFileName

public void setFileName(String filename)

Set the name of the local file (without path).

Parameters:

filename - The file name to set.

getFilePath

public String getFilePath()

Get the full path of the local file (including filename).

Returns:

the file path.

setFilePath

public void setFilePath(String filepath)

Set the full path of the local file (including filename).

Parameters:

filepath - The file pathto set.

getOther

public IComponentIdentifier getOther()

Get the opposite component.

Returns:

the CID.

setOther

public void setOther(IComponentIdentifier other)

Set the opposite component.

Parameters:

other - The CID to set.

getSize

public long getSize()

Get the size.

Returns:

the size.

setSize

public void setSize(long size)

Set the size.

Parameters:

size - The size to set.

getTimeout

public long getTimeout()

Get the timeout.

Returns:

the absolute timeout value.

setTimeout

public void setTimeout(long timeout)

Set the timeout.

Parameters:

timeout - The absolute timeout value to set.

getDone

public long getDone()

Get the done.

Returns:

the done.

setDone

public void setDone(long done)

Set the done.

Parameters:

done - The done to set.

update

public boolean update(long done)

Update the transfer info. Use this method instead of set done for having the transfer speed calculated.

Parameters:

done - The done to set.

Returns:

True, when a new speed has been calculated (approx. once per second).

getId

public String getId()

Get the id.

Returns:

the id.

setId

public void setId(String id)

Set the id.

getState

public String getState()

Get the state.

Returns:

the state.

isDownload

public boolean isDownload()

Check if transfer is a download or upload.

setDownload

public void setDownload(boolean download)

Set the transfer as a download or upload.

getSpeed

public double getSpeed()

Get the speed.

Returns:

the speed.

setSpeed

public void setSpeed(double speed)

Set the speed.

setState

public void setState(String state)

Set the state.

Parameters:

state - The state to set.

isFinished

public boolean isFinished()

Check if transfer is finished.

hashCode

public int hashCode()

Get the hash code.

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Test for equality.

Overrides:

equals in class Object