ResourcePayload

ResourcePayload


				abstract						ResourcePayload				implements Payload

Extend this class for an easy implemenation of a not bufferable Payload. See {@Payload::isBufferable() for more information.

All Implemented Interfaces:

Payload

SubTypes

FilePayload

Methods summary

Modifier and Type	Method
public bool	isBufferable ( )
public string	getBufferedContents ( )

Methods in detail

isBufferable

bool public isBufferable ( )

Returns true if the content of this Payload can be buffered and returned by Payload::getBufferedContents(). This would be false if this Payload contained a large file which can not be buffered due to lack of memory.

Implemation examples:

		
			Payload (bufferable)
			File (not bufferable)

see

Payload::isBufferable()

return

bool

Specified: Payload

Overrides: Payload::isBufferable()

getBufferedContents

string public getBufferedContents ( )

Returns the buffered content of this response object. See Payload::isBufferable() for more information.

see

Payload::getBufferedContents()

return

string

throws

IllegalStateException if Payload returns false.

Specified: Payload

Overrides: Payload::getBufferedContents()