/*
- * jSite2 - AllData.java -
- * Copyright © 2008 David Roden
+ * jFCPlib - AllData.java - Copyright © 2008 David Roden
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* {@link #getPayloadInputStream()} to get the data. If an AllData message
* passes through all registered {@link FcpListener}s without the payload being
* consumed, the payload is discarded!
- *
- * @author <a href="mailto:dr@ina-germany.de">David Roden</a>
+ *
+ * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
*/
public class AllData extends BaseMessage {
/**
* Creates an “AllData” message that wraps the received message.
- *
+ *
* @param receivedMessage
* The received message
* @param payloadInputStream
/**
* Returns the identifier of the request.
- *
+ *
* @return The identifier of the request
*/
public String getIdentifier() {
/**
* Returns the length of the data.
- *
+ *
* @return The length of the data, or <code>-1</code> if the length could
* not be parsed
*/
/**
* Returns the startup time of the request.
- *
+ *
* @return The startup time of the request (in milliseconds since Jan 1,
* 1970 UTC), or <code>-1</code> if the time could not be parsed
*/
/**
* Returns the completion time of the request.
- *
+ *
* @return The completion time of the request (in milliseconds since Jan 1,
* 1970 UTC), or <code>-1</code> if the time could not be parsed
*/
}
/**
- * Returns the payload input stream.
- *
+ * Returns the payload input stream. You <strong>have</strong> consume the
+ * input stream before returning from the
+ * {@link FcpListener#receivedAllData(FcpConnection, AllData)} method!
+ *
* @return The payload
*/
public InputStream getPayloadInputStream() {