/*
- * jSite2 - SimpleProgress.java -
- * Copyright © 2008 David Roden
+ * jFCPlib - SimpleProgress.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
/**
* A “SimpleProgress” message tells the client about the progress of a
* {@link ClientGet} or {@link ClientPut} operation.
- *
+ *
* @author David ‘Bombe’ Roden <bombe@freenetproject.org>
- * @version $Id$
*/
public class SimpleProgress extends BaseMessage {
/**
* Creates a new “SimpleProgress” message that wraps the received message.
- *
+ *
* @param receivedMessage
* The received message
*/
/**
* Returns the total number of blocks. This number may increase as long as
* {@link #isFinalizedTotal()} returns <code>false</code>.
- *
+ *
* @return The total number of blocks
*/
public int getTotal() {
* This number might actually be lower than {@link #getTotal} because of
* redundancy information. This number may also increase as long as
* {@link #isFinalizedTotal()} returns <code>false</code>.
- *
+ *
* @return The number of required blocks
*/
public int getRequired() {
/**
* Returns the number of blocks that have failed and run out of retries.
- *
+ *
* @return The number of failed blocks
*/
public int getFailed() {
/**
* Returns the number of fatally failed blocks. A block that failed fatally
* can never be completed, even with infinite retries.
- *
+ *
* @return The number of fatally failed blocks
*/
public int getFatallyFailed() {
/**
* Returns the number of blocks that have been successfully processed.
- *
+ *
* @return The number of succeeded blocks
*/
public int getSucceeded() {
* been finalized. Once the total number of blocks has been finalized for a
* request it will not change any more, and this method of every further
* SimpleProgress message will always return <code>true</code>.
- *
+ *
* @return <code>true</code> if the number of total blocks has been
* finalized, <code>false</code> otherwise
*/
/**
* Returns the identifier of the request.
- *
+ *
* @return The identifier of the request
*/
public String getIdentifier() {