org.arl.fjage.shell

Class PutFileReq

java.lang.Object

org.arl.fjage.Message

org.arl.fjage.shell.PutFileReq

All Implemented Interfaces:

java.io.Serializable

public class PutFileReq
extends Message

Request to write contents to a file, or delete a file.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.arl.fjage.Message

inReplyTo, msgID, perf, recipient, sender, sentAt

Constructor Summary

Constructors

Constructor and Description
PutFileReq() Create an empty request for file write.
PutFileReq(AgentID to) Create an empty request for file write.
PutFileReq(AgentID to, java.lang.String filename, byte[] contents) Create request for file write.
PutFileReq(AgentID to, java.lang.String filename, byte[] contents, long ofs) Create request for file write.
PutFileReq(java.lang.String filename, byte[] contents) Create request for file write.
PutFileReq(java.lang.String filename, byte[] contents, long ofs) Create request for file write.

Method Summary

Modifier and Type	Method and Description
byte[]	getContents() Get the contents to write to the file.
java.lang.String	getFilename() Get the name of the file.
long	getOffset() Get the start location in file to write to.
void	setContents(byte[] contents) Set the contents to write to the file.
void	setFilename(java.lang.String filename) Set the name of the file.
void	setOffset(long ofs) Set the start location in file to write from.

Methods inherited from class org.arl.fjage.Message

getInReplyTo, getJsonCache, getMessageID, getPerformative, getRecipient, getSender, getSentAt, setInReplyTo, setJsonCache, setMessageID, setPerformative, setRecipient, setSender, setSentAt, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PutFileReq

public PutFileReq()

Create an empty request for file write.

PutFileReq

public PutFileReq(AgentID to)

Create an empty request for file write.

Parameters:

to - shell agent id.

PutFileReq

public PutFileReq(java.lang.String filename,
                  byte[] contents)

Create request for file write.

Parameters:

filename - name of the file to write.

contents - contents to write to the file (null to delete file).

PutFileReq

public PutFileReq(java.lang.String filename,
                  byte[] contents,
                  long ofs)

Create request for file write.

Parameters:

filename - name of the file to write.

contents - contents to write to the file (null to delete file).

ofs - offset within the file to write the contents to

PutFileReq

public PutFileReq(AgentID to,
                  java.lang.String filename,
                  byte[] contents)

Create request for file write.

Parameters:

to - shell agent id.

filename - name of the file to write.

contents - contents to write to the file (null to delete file).

PutFileReq

public PutFileReq(AgentID to,
                  java.lang.String filename,
                  byte[] contents,
                  long ofs)

Create request for file write.

Parameters:

to - shell agent id.

filename - name of the file to write.

contents - contents to write to the file (null to delete file).

ofs - offset within the file to write the contents to.

Method Detail

getFilename

public java.lang.String getFilename()

Get the name of the file.

Returns:

name of the file.

setFilename

public void setFilename(java.lang.String filename)

Set the name of the file.

Parameters:

filename - name of the file.

getContents

public byte[] getContents()

Get the contents to write to the file.

Returns:

the contents to write to the file.

setContents

public void setContents(byte[] contents)

Set the contents to write to the file.

Parameters:

contents - the contents to write to the file (null to delete file).

getOffset

public long getOffset()

Get the start location in file to write to.

Returns:

start locaion in file (negative for offset relative to end of file).

setOffset

public void setOffset(long ofs)

Set the start location in file to write from.

Parameters:

ofs - start location in file (negative for offset relative to end of file).