From: David ‘Bombe’ Roden Date: Thu, 23 Jul 2009 04:23:06 +0000 (+0200) Subject: More whitespace fixes. X-Git-Tag: v0.1.1~14 X-Git-Url: https://git.pterodactylus.net/?p=jFCPlib.git;a=commitdiff_plain;h=a655177a4605236e866ac7e0ce32f7cb5289cbc4 More whitespace fixes. --- diff --git a/src/net/pterodactylus/fcp/ARK.java b/src/net/pterodactylus/fcp/ARK.java index 55a625f..498252d 100644 --- a/src/net/pterodactylus/fcp/ARK.java +++ b/src/net/pterodactylus/fcp/ARK.java @@ -20,7 +20,7 @@ package net.pterodactylus.fcp; /** * Container for ARKs (address resolution keys). - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class ARK { @@ -36,7 +36,7 @@ public class ARK { /** * Creates a new ARK with the given URI and number. - * + * * @param publicURI * The public URI of the ARK * @param number @@ -48,7 +48,7 @@ public class ARK { /** * Creates a new ARK with the given URIs and number. - * + * * @param publicURI * The public URI of the ARK * @param privateURI @@ -71,7 +71,7 @@ public class ARK { /** * Returns the public URI of the ARK. - * + * * @return The public URI of the ARK */ public String getPublicURI() { @@ -80,7 +80,7 @@ public class ARK { /** * Returns the private URI of the ARK. - * + * * @return The private URI of the ARK */ public String getPrivateURI() { @@ -89,7 +89,7 @@ public class ARK { /** * Returns the number of the ARK. - * + * * @return The number of the ARK */ public int getNumber() { diff --git a/src/net/pterodactylus/fcp/AddPeer.java b/src/net/pterodactylus/fcp/AddPeer.java index 2afa5e2..e9ad80d 100644 --- a/src/net/pterodactylus/fcp/AddPeer.java +++ b/src/net/pterodactylus/fcp/AddPeer.java @@ -22,7 +22,7 @@ import java.net.URL; /** * The “AddPeer” request adds a peer to the node. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class AddPeer extends FcpMessage { @@ -37,7 +37,7 @@ public class AddPeer extends FcpMessage { /** * Creates a new “AddPeer” request that reads the noderef of the peer from * the given file. - * + * * @param file * The file to read the noderef from */ @@ -49,7 +49,7 @@ public class AddPeer extends FcpMessage { /** * Creates a new “AddPeer” request that reads the noderef of the peer from * the given URL. - * + * * @param url * The URL to read the noderef from */ @@ -60,7 +60,7 @@ public class AddPeer extends FcpMessage { /** * Creates a new “AddPeer” request that adds the peer given by the noderef. - * + * * @param nodeRef * The noderef of the peer */ @@ -75,7 +75,7 @@ public class AddPeer extends FcpMessage { /** * Sets the noderef of the peer to add. - * + * * @param nodeRef * The noderef of the peer */ diff --git a/src/net/pterodactylus/fcp/AllData.java b/src/net/pterodactylus/fcp/AllData.java index aaa0c55..d1541bf 100644 --- a/src/net/pterodactylus/fcp/AllData.java +++ b/src/net/pterodactylus/fcp/AllData.java @@ -28,7 +28,7 @@ import java.io.InputStream; * {@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 David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class AllData extends BaseMessage { @@ -38,7 +38,7 @@ public class AllData extends BaseMessage { /** * Creates an “AllData” message that wraps the received message. - * + * * @param receivedMessage * The received message * @param payloadInputStream @@ -51,7 +51,7 @@ public class AllData extends BaseMessage { /** * Returns the identifier of the request. - * + * * @return The identifier of the request */ public String getIdentifier() { @@ -60,7 +60,7 @@ public class AllData extends BaseMessage { /** * Returns the length of the data. - * + * * @return The length of the data, or -1 if the length could * not be parsed */ @@ -70,7 +70,7 @@ public class AllData extends BaseMessage { /** * Returns the startup time of the request. - * + * * @return The startup time of the request (in milliseconds since Jan 1, * 1970 UTC), or -1 if the time could not be parsed */ @@ -80,7 +80,7 @@ public class AllData extends BaseMessage { /** * Returns the completion time of the request. - * + * * @return The completion time of the request (in milliseconds since Jan 1, * 1970 UTC), or -1 if the time could not be parsed */ @@ -92,7 +92,7 @@ public class AllData extends BaseMessage { * Returns the payload input stream. You have consume the * input stream before returning from the * {@link FcpListener#receivedAllData(FcpConnection, AllData)} method! - * + * * @return The payload */ public InputStream getPayloadInputStream() { diff --git a/src/net/pterodactylus/fcp/BaseMessage.java b/src/net/pterodactylus/fcp/BaseMessage.java index 12500f4..a5ea020 100644 --- a/src/net/pterodactylus/fcp/BaseMessage.java +++ b/src/net/pterodactylus/fcp/BaseMessage.java @@ -22,7 +22,7 @@ import java.util.Map; /** * A basic message abstraction that wraps a received FCP message. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class BaseMessage { @@ -32,7 +32,7 @@ public class BaseMessage { /** * Creates a new base message that wraps the given message. - * + * * @param receivedMessage * The FCP message that was received */ @@ -42,7 +42,7 @@ public class BaseMessage { /** * Returns the name of the message. - * + * * @return The name of the message */ public String getName() { @@ -51,7 +51,7 @@ public class BaseMessage { /** * Returns the content of the field. - * + * * @param field * The name of the field * @return The content of the field, or null if there is no @@ -63,7 +63,7 @@ public class BaseMessage { /** * Returns all fields from the received message. - * + * * @see FcpMessage#getFields() * @return All fields from the message */ diff --git a/src/net/pterodactylus/fcp/ClientGet.java b/src/net/pterodactylus/fcp/ClientGet.java index cb6783f..8b03ee4 100644 --- a/src/net/pterodactylus/fcp/ClientGet.java +++ b/src/net/pterodactylus/fcp/ClientGet.java @@ -20,14 +20,14 @@ package net.pterodactylus.fcp; /** * A “ClientGet” request is used for download files from the Freenet node. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class ClientGet extends FcpMessage { /** * Creates a new “ClientGet” request. - * + * * @param uri * The URI to get * @param identifier @@ -39,7 +39,7 @@ public class ClientGet extends FcpMessage { /** * Creates a new “ClientGet” request. - * + * * @param uri * The URI to get * @param identifier @@ -57,7 +57,7 @@ public class ClientGet extends FcpMessage { /** * Sets whether the local data store should be ignored when searching for a * key. - * + * * @param ignoreDataStore * true to ignore the local data store, * false to include it @@ -69,7 +69,7 @@ public class ClientGet extends FcpMessage { /** * Sets whether the search for the key should be restricted to the local * data store only. - * + * * @param dsOnly * true to restrict the search to the local data * store, false to search on other nodes, too @@ -80,7 +80,7 @@ public class ClientGet extends FcpMessage { /** * Sets the verbosity of the request. - * + * * @param verbosity * The verbosity of the request */ @@ -91,7 +91,7 @@ public class ClientGet extends FcpMessage { /** * Sets the maximum size of the file to retrieve. If the file is larger than * this size the request will fail! - * + * * @param maxSize * The maximum size of the file to retrieve */ @@ -102,7 +102,7 @@ public class ClientGet extends FcpMessage { /** * Sets the maximum size of temporary files created by the node. If a * temporary file is larger than this size the request will fail! - * + * * @param maxTempSize * The maximum size of temporary files */ @@ -112,7 +112,7 @@ public class ClientGet extends FcpMessage { /** * The maximum number of retries in case a block can not be retrieved. - * + * * @param maxRetries * The maximum number of retries for failed blocks, * -1 to try forever @@ -123,7 +123,7 @@ public class ClientGet extends FcpMessage { /** * Sets the priority of the request. - * + * * @param priority * The priority of the request */ @@ -133,7 +133,7 @@ public class ClientGet extends FcpMessage { /** * Sets the persistence of the request. - * + * * @param persistence * The persistence of the request */ @@ -143,7 +143,7 @@ public class ClientGet extends FcpMessage { /** * Sets the client token of the request. - * + * * @param clientToken * The client token of the request */ @@ -153,7 +153,7 @@ public class ClientGet extends FcpMessage { /** * Sets whether the request should be visible on the global queue. - * + * * @param global * true to make the request visible on the global * queue, false for client-local queue only @@ -164,7 +164,7 @@ public class ClientGet extends FcpMessage { /** * Sets whether to request the “binary blob” for a key. - * + * * @param binaryBlob * true to request the binary blob, * false to get the “real thing” @@ -177,7 +177,7 @@ public class ClientGet extends FcpMessage { * Sets the allowed MIME types of the requested file. If the MIME type of * the file does not match one of the given MIME types the request will * fail! - * + * * @param allowedMimeTypes * The allowed MIME types */ @@ -188,7 +188,7 @@ public class ClientGet extends FcpMessage { /** * Sets the filename to download the file to. You should only call this * method if your return type is {@link ReturnType#disk}! - * + * * @param filename * The filename to download the file to */ @@ -199,7 +199,7 @@ public class ClientGet extends FcpMessage { /** * Sets the name for the temporary file. You should only call this method if * your return type is {@link ReturnType#disk}! - * + * * @param tempFilename * The name of the temporary file */ diff --git a/src/net/pterodactylus/fcp/ClientHello.java b/src/net/pterodactylus/fcp/ClientHello.java index 6600c44..3079807 100644 --- a/src/net/pterodactylus/fcp/ClientHello.java +++ b/src/net/pterodactylus/fcp/ClientHello.java @@ -21,7 +21,7 @@ package net.pterodactylus.fcp; /** * A “ClientHello” message that must be sent to the node first thing * after calling {@link FcpConnection#connect()}. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class ClientHello extends FcpMessage { @@ -30,7 +30,7 @@ public class ClientHello extends FcpMessage { * Creates a new “ClientHello” message with the given client name. The * client name has to be unique to the node otherwise you will get a * {@link CloseConnectionDuplicateClientName} response from the node! - * + * * @param clientName * The unique client name */ @@ -43,7 +43,7 @@ public class ClientHello extends FcpMessage { * client name has to be unique to the node otherwise you will get a * {@link CloseConnectionDuplicateClientName} response from the node! The * expected FCP version is currently ignored by the node. - * + * * @param clientName * The unique client name * @param expectedVersion diff --git a/src/net/pterodactylus/fcp/ClientPut.java b/src/net/pterodactylus/fcp/ClientPut.java index 0022735..f7dfabc 100644 --- a/src/net/pterodactylus/fcp/ClientPut.java +++ b/src/net/pterodactylus/fcp/ClientPut.java @@ -23,7 +23,7 @@ package net.pterodactylus.fcp; * it directly with this messge ({@link UploadFrom#direct}), uploading it from * disk ({@link UploadFrom#disk}) or by creating a redirect to another URI ( * {@link UploadFrom#redirect}). - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class ClientPut extends FcpMessage { @@ -35,7 +35,7 @@ public class ClientPut extends FcpMessage { * constructor is the same as using * {@link #ClientPut(String, String, UploadFrom)} with * {@link UploadFrom#direct} as third parameter. - * + * * @param uri * The URI to insert the file to * @param identifier @@ -57,7 +57,7 @@ public class ClientPut extends FcpMessage { * before using this option! If uploadFrom is * {@link UploadFrom#redirect}, use {@link #setTargetURI(String)} to set the * target URI of the redirect. - * + * * @param uri * The URI to insert to * @param identifier @@ -74,7 +74,7 @@ public class ClientPut extends FcpMessage { /** * The MIME type of the content. - * + * * @param metadataContentType * The MIME type of the content */ @@ -86,7 +86,7 @@ public class ClientPut extends FcpMessage { * The verbosity of the request. Depending on this parameter you will * received only the bare minimum of messages for the request (i.e. “it * completed”) or a whole lot more. - * + * * @see Verbosity * @param verbosity * The verbosity of the request @@ -97,7 +97,7 @@ public class ClientPut extends FcpMessage { /** * The number of retries for a request if the initial try failed. - * + * * @param maxRetries * The maximum number of retries after failure, or * -1 to retry forever. @@ -108,7 +108,7 @@ public class ClientPut extends FcpMessage { /** * Sets the priority of the request. - * + * * @param priority * The priority of the request */ @@ -119,7 +119,7 @@ public class ClientPut extends FcpMessage { /** * Determines whether the node should really insert the data or generate the * final CHK only. - * + * * @param getCHKOnly * true to generate the final CHK only, * false to really insert the data @@ -130,7 +130,7 @@ public class ClientPut extends FcpMessage { /** * Determines whether this request appears on the global queue. - * + * * @param global * true to put the request on the global queue, * false for the client-local queue. @@ -142,7 +142,7 @@ public class ClientPut extends FcpMessage { /** * Determines whether the node should skip compression because the file has * already been compressed. - * + * * @param dontCompress * true to skip compression of the data in the node, * false to allow compression @@ -155,7 +155,7 @@ public class ClientPut extends FcpMessage { * Sets an optional client token. This client token is mentioned in progress * and other request-related messages and can be used to identify this * request. - * + * * @param clientToken * The client token */ @@ -165,7 +165,7 @@ public class ClientPut extends FcpMessage { /** * Sets the persistence of this request. - * + * * @param persistence * The persistence of this request */ @@ -176,7 +176,7 @@ public class ClientPut extends FcpMessage { /** * Sets the target filename of the inserted file. This value is ignored for * all inserts that do not have “CHK@” as a target. - * + * * @param targetFilename * The filename of the target */ @@ -187,7 +187,7 @@ public class ClientPut extends FcpMessage { /** * Determines whether to encode the complete file early in the life of the * request. - * + * * @param earlyEncode * true to generate the final key long before the * file is completely fetchable @@ -199,7 +199,7 @@ public class ClientPut extends FcpMessage { /** * Sets the length of the data that will be transferred after this message * if uploadFrom is {@link UploadFrom#direct} is used. - * + * * @param dataLength * The length of the data */ @@ -209,7 +209,7 @@ public class ClientPut extends FcpMessage { /** * Sets the name of the file to upload the data from. - * + * * @param filename * The filename to upload */ @@ -220,7 +220,7 @@ public class ClientPut extends FcpMessage { /** * If uploadFrom is {@link UploadFrom#redirect}, use this * method to determine that target of the redirect. - * + * * @param targetURI * The target URI to redirect to */ diff --git a/src/net/pterodactylus/fcp/ClientPutComplexDir.java b/src/net/pterodactylus/fcp/ClientPutComplexDir.java index 28bc4c0..55e5779 100644 --- a/src/net/pterodactylus/fcp/ClientPutComplexDir.java +++ b/src/net/pterodactylus/fcp/ClientPutComplexDir.java @@ -33,7 +33,7 @@ import net.pterodactylus.fcp.FileEntry.DirectFileEntry; /** * The “ClientPutComplexDir” lets you upload a directory with different sources * for each file. - * + * * @see FileEntry * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ @@ -47,7 +47,7 @@ public class ClientPutComplexDir extends FcpMessage { /** * Creates a new “ClientPutComplexDir” with the given identifier and URI. - * + * * @param identifier * The identifier of the request * @param uri @@ -61,7 +61,7 @@ public class ClientPutComplexDir extends FcpMessage { /** * Sets the verbosity of the request. - * + * * @param verbosity * The verbosity of the request */ @@ -71,7 +71,7 @@ public class ClientPutComplexDir extends FcpMessage { /** * Sets the maximum number of retries for failed blocks. - * + * * @param maxRetries * The maximum number of retries for failed blocks, or * -1 to retry endlessly @@ -82,7 +82,7 @@ public class ClientPutComplexDir extends FcpMessage { /** * Sets the priority of the request. - * + * * @param priority * The priority of the request */ @@ -92,7 +92,7 @@ public class ClientPutComplexDir extends FcpMessage { /** * Sets whether to generate the final URI only. - * + * * @param getCHKOnly * true to generate the final CHK only, * false to complete the insert @@ -103,7 +103,7 @@ public class ClientPutComplexDir extends FcpMessage { /** * Sets whether the request is on the global queue. - * + * * @param global * true to put the request on the global queue, * false to put it on the client-local queue @@ -114,7 +114,7 @@ public class ClientPutComplexDir extends FcpMessage { /** * Sets whether the node should not try to compress the data. - * + * * @param dontCompress * true to skip compression of the data, * false to try and compress the data @@ -125,7 +125,7 @@ public class ClientPutComplexDir extends FcpMessage { /** * Sets the client token of the request. - * + * * @param clientToken * The client token of the request */ @@ -135,7 +135,7 @@ public class ClientPutComplexDir extends FcpMessage { /** * Sets the persistence of the request. - * + * * @param persistence * The persistence of the request */ @@ -146,7 +146,7 @@ public class ClientPutComplexDir extends FcpMessage { /** * Sets the target filename of the request. This is useful for inserts that * go to “CHK@” only and creates a manifest with a single file. - * + * * @param targetFilename * The target filename */ @@ -157,7 +157,7 @@ public class ClientPutComplexDir extends FcpMessage { /** * Sets whether to encode the complete data early to generate the * {@link URIGenerated} message early. - * + * * @param earlyEncode * true to encode the complete data early, * false otherwise @@ -169,7 +169,7 @@ public class ClientPutComplexDir extends FcpMessage { /** * Sets the default name. This is the name of the file that should be shown * if no file was specified. - * + * * @param defaultName * The default name */ @@ -179,7 +179,7 @@ public class ClientPutComplexDir extends FcpMessage { /** * Adds an entry for a file. - * + * * @param fileEntry * The file entry to add */ diff --git a/src/net/pterodactylus/fcp/ClientPutDiskDir.java b/src/net/pterodactylus/fcp/ClientPutDiskDir.java index f52c5cc..d9b3924 100644 --- a/src/net/pterodactylus/fcp/ClientPutDiskDir.java +++ b/src/net/pterodactylus/fcp/ClientPutDiskDir.java @@ -21,14 +21,14 @@ package net.pterodactylus.fcp; /** * The “ClientPutDiskDir” message is used to insert a complete directory from * the disk to a single key. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class ClientPutDiskDir extends FcpMessage { /** * Creates a new “ClientPutDiskDir” message. - * + * * @param uri * The URI to insert the file to * @param identifier @@ -47,7 +47,7 @@ public class ClientPutDiskDir extends FcpMessage { * The verbosity of the request. Depending on this parameter you will * received only the bare minimum of messages for the request (i.e. “it * completed”) or a whole lot more. - * + * * @see Verbosity * @param verbosity * The verbosity of the request @@ -58,7 +58,7 @@ public class ClientPutDiskDir extends FcpMessage { /** * The number of retries for a request if the initial try failed. - * + * * @param maxRetries * The maximum number of retries after failure, or * -1 to retry forever. @@ -69,7 +69,7 @@ public class ClientPutDiskDir extends FcpMessage { /** * Sets the priority of the request. - * + * * @param priority * The priority of the request */ @@ -80,7 +80,7 @@ public class ClientPutDiskDir extends FcpMessage { /** * Determines whether the node should really insert the data or generate the * final CHK only. - * + * * @param getCHKOnly * true to generate the final CHK only, * false to really insert the data @@ -91,7 +91,7 @@ public class ClientPutDiskDir extends FcpMessage { /** * Determines whether this request appears on the global queue. - * + * * @param global * true to put the request on the global queue, * false for the client-local queue. @@ -103,7 +103,7 @@ public class ClientPutDiskDir extends FcpMessage { /** * Determines whether the node should skip compression because the file has * already been compressed. - * + * * @param dontCompress * true to skip compression of the data in the node, * false to allow compression @@ -116,7 +116,7 @@ public class ClientPutDiskDir extends FcpMessage { * Sets an optional client token. This client token is mentioned in progress * and other request-related messages and can be used to identify this * request. - * + * * @param clientToken * The client token */ @@ -126,7 +126,7 @@ public class ClientPutDiskDir extends FcpMessage { /** * Sets the persistence of this request. - * + * * @param persistence * The persistence of this request */ @@ -137,7 +137,7 @@ public class ClientPutDiskDir extends FcpMessage { /** * Sets the name of the default file. The default file is shown when the key * is requested with an additional name. - * + * * @param defaultName * The name of the default file */ @@ -147,7 +147,7 @@ public class ClientPutDiskDir extends FcpMessage { /** * Sets whether unreadable files allow the insert to continue. - * + * * @param allowUnreadableFiles * true to just ignore unreadable files, * false to let the insert fail when an unreadable diff --git a/src/net/pterodactylus/fcp/CloseConnectionDuplicateClientName.java b/src/net/pterodactylus/fcp/CloseConnectionDuplicateClientName.java index 1235541..db0ff0d 100644 --- a/src/net/pterodactylus/fcp/CloseConnectionDuplicateClientName.java +++ b/src/net/pterodactylus/fcp/CloseConnectionDuplicateClientName.java @@ -20,7 +20,7 @@ package net.pterodactylus.fcp; /** * A “CloseConnectionDuplicateClientName” message. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class CloseConnectionDuplicateClientName extends BaseMessage { @@ -28,7 +28,7 @@ public class CloseConnectionDuplicateClientName extends BaseMessage { /** * Creates a new CloseConnectionDuplicateClientName message that wraps the * given message. - * + * * @param receivedMessage * The received message */ diff --git a/src/net/pterodactylus/fcp/ConfigData.java b/src/net/pterodactylus/fcp/ConfigData.java index 5d0e87a..4eb7954 100644 --- a/src/net/pterodactylus/fcp/ConfigData.java +++ b/src/net/pterodactylus/fcp/ConfigData.java @@ -20,7 +20,7 @@ package net.pterodactylus.fcp; /** * A “ConfigData” message contains various aspects of the node’s configuration. - * + * * @see GetConfig * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ @@ -28,7 +28,7 @@ public class ConfigData extends BaseMessage { /** * Creates a new “ConfigData” message that wraps the received message. - * + * * @param receivedMessage * The received message */ @@ -38,7 +38,7 @@ public class ConfigData extends BaseMessage { /** * Returns the current value of the given option. - * + * * @param option * The name of the option * @return The current value of the option @@ -49,7 +49,7 @@ public class ConfigData extends BaseMessage { /** * Returns the short description of the given option. - * + * * @param option * The name of the option * @return The short description of the option @@ -60,7 +60,7 @@ public class ConfigData extends BaseMessage { /** * Returns the long description of the given option. - * + * * @param option * The name of the option * @return The long description of the option @@ -71,7 +71,7 @@ public class ConfigData extends BaseMessage { /** * Returns the data type of the given option. - * + * * @param option * The name of the option * @return The data type of the option @@ -82,7 +82,7 @@ public class ConfigData extends BaseMessage { /** * Returns the default value of the given option. - * + * * @param option * The name of the option * @return The default value of the option @@ -93,7 +93,7 @@ public class ConfigData extends BaseMessage { /** * Returns the sort order of the given option. - * + * * @param option * The name of the option * @return The sort order of the option, or -1 if the sort @@ -105,7 +105,7 @@ public class ConfigData extends BaseMessage { /** * Returns the expert flag of the given option. - * + * * @param option * The name of the option * @return The expert flag of the option @@ -116,7 +116,7 @@ public class ConfigData extends BaseMessage { /** * Returns the force-write flag of the given option - * + * * @param option * The name of the option * @return The force-write flag of the given option diff --git a/src/net/pterodactylus/fcp/DSAGroup.java b/src/net/pterodactylus/fcp/DSAGroup.java index 3f7e18f..4674e66 100644 --- a/src/net/pterodactylus/fcp/DSAGroup.java +++ b/src/net/pterodactylus/fcp/DSAGroup.java @@ -23,7 +23,7 @@ import java.security.interfaces.DSAParams; /** * Container for the DSA group of a peer. A DSA group consists of a base (called * “g”), a prime (called “p”) and a subprime (called “q”). - * + * * @see DSAParams * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ @@ -41,7 +41,7 @@ public class DSAGroup { /** * Creates a new DSA group with the given base (“g”), prime (“p”), and * subprime (“q”). - * + * * @param base * The base of the DSA group * @param prime @@ -57,7 +57,7 @@ public class DSAGroup { /** * Returns the base (“g”) of the DSA group. - * + * * @return The base of the DSA group */ public String getBase() { @@ -66,7 +66,7 @@ public class DSAGroup { /** * Returns the prime (“p”) of the DSA group. - * + * * @return The prime of the DSA group */ public String getPrime() { @@ -75,7 +75,7 @@ public class DSAGroup { /** * Returns the subprime (“q”) of the DSA group. - * + * * @return The subprime of the DSA group */ public String getSubprime() { diff --git a/src/net/pterodactylus/fcp/DataFound.java b/src/net/pterodactylus/fcp/DataFound.java index 46679ac..81318c1 100644 --- a/src/net/pterodactylus/fcp/DataFound.java +++ b/src/net/pterodactylus/fcp/DataFound.java @@ -22,14 +22,14 @@ package net.pterodactylus.fcp; * A “DataFound” message signals the client that the data requested by a * {@link ClientGet} operation has been found. This message does not include the * actual data, though. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class DataFound extends BaseMessage { /** * Creates a new “DataFound” message that wraps the received message. - * + * * @param receivedMessage * The received message */ @@ -39,7 +39,7 @@ public class DataFound extends BaseMessage { /** * Returns whether the request is on the global queue. - * + * * @return true if the request is on the global queue, * false if the request is on the client-local queue */ @@ -49,7 +49,7 @@ public class DataFound extends BaseMessage { /** * Returns the identifier of the request. - * + * * @return The identifier of the request */ public String getIdentifier() { @@ -58,7 +58,7 @@ public class DataFound extends BaseMessage { /** * Returns the content type of the data. - * + * * @return The content type of the data */ public String getMetadataContentType() { @@ -67,7 +67,7 @@ public class DataFound extends BaseMessage { /** * Returns the length of the data. - * + * * @return The length of the data */ public long getDataLength() { diff --git a/src/net/pterodactylus/fcp/EndListPeerNotes.java b/src/net/pterodactylus/fcp/EndListPeerNotes.java index 3a736be..5c381f6 100644 --- a/src/net/pterodactylus/fcp/EndListPeerNotes.java +++ b/src/net/pterodactylus/fcp/EndListPeerNotes.java @@ -21,14 +21,14 @@ package net.pterodactylus.fcp; /** * The “EndListPeerNotes” message signals the end of a list of “PeerNote” * messages. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class EndListPeerNotes extends BaseMessage { /** * Creates a new “EndListPeerNotes” message that wraps the received message. - * + * * @param fcpMessage * The received message */ diff --git a/src/net/pterodactylus/fcp/EndListPeers.java b/src/net/pterodactylus/fcp/EndListPeers.java index edba692..c0cf82f 100644 --- a/src/net/pterodactylus/fcp/EndListPeers.java +++ b/src/net/pterodactylus/fcp/EndListPeers.java @@ -20,14 +20,14 @@ package net.pterodactylus.fcp; /** * This message marks the end of a list of “Peer” replies. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class EndListPeers extends BaseMessage { /** * Creates a new “EndListPeers” message that wraps the received message. - * + * * @param receivedMessage * The message that was received */ @@ -37,7 +37,7 @@ public class EndListPeers extends BaseMessage { /** * Returns the identifier of the request. - * + * * @return The identifier of the request */ public String getIdentifier() { diff --git a/src/net/pterodactylus/fcp/EndListPersistentRequests.java b/src/net/pterodactylus/fcp/EndListPersistentRequests.java index 81d72dc..893f2f1 100644 --- a/src/net/pterodactylus/fcp/EndListPersistentRequests.java +++ b/src/net/pterodactylus/fcp/EndListPersistentRequests.java @@ -21,7 +21,7 @@ package net.pterodactylus.fcp; /** * The “EndListPersistentRequests” message signals the end of a list of * {@link PersistentGet} and {@link PersistentPut} requests. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class EndListPersistentRequests extends BaseMessage { @@ -29,7 +29,7 @@ public class EndListPersistentRequests extends BaseMessage { /** * Creates a new “EndListPersistentRequests” message that wraps the received * message. - * + * * @param receivedMessage * The received message */ diff --git a/src/net/pterodactylus/fcp/FCPPluginMessage.java b/src/net/pterodactylus/fcp/FCPPluginMessage.java index d429867..c167411 100644 --- a/src/net/pterodactylus/fcp/FCPPluginMessage.java +++ b/src/net/pterodactylus/fcp/FCPPluginMessage.java @@ -21,14 +21,14 @@ package net.pterodactylus.fcp; /** * An “CPPluginMessage” sends a message with custom parameters and (optional) * payload to a plugin. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class FCPPluginMessage extends FcpMessage { /** * Creates a new “FCPPluginMessage” message for the given plugin. - * + * * @param pluginClass * The name of the plugin class */ @@ -41,7 +41,7 @@ public class FCPPluginMessage extends FcpMessage { * Sets the identifier of the request. Though this is still optional you are * encouraged to include it because the plugin might reply in random order * to requests. - * + * * @param identifier * The identifier of the request */ @@ -51,7 +51,7 @@ public class FCPPluginMessage extends FcpMessage { /** * Sets a custom parameter for the plugin. - * + * * @param key * The key of the parameter * @param value @@ -65,7 +65,7 @@ public class FCPPluginMessage extends FcpMessage { * Sets the length of data of the optional payload. If you call this method * you also have to call {@link #setPayloadInputStream(java.io.InputStream)} * ! - * + * * @param dataLength * The length of data in the payload input stream */ diff --git a/src/net/pterodactylus/fcp/FcpAdapter.java b/src/net/pterodactylus/fcp/FcpAdapter.java index 438574c..6bb2f50 100644 --- a/src/net/pterodactylus/fcp/FcpAdapter.java +++ b/src/net/pterodactylus/fcp/FcpAdapter.java @@ -20,7 +20,7 @@ package net.pterodactylus.fcp; /** * Adapter for {@link FcpListener}. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class FcpAdapter implements FcpListener { @@ -83,7 +83,7 @@ public class FcpAdapter implements FcpListener { /** * {@inheritDoc} - * + * * @see FcpListener#receivedNodeData(FcpConnection, NodeData) */ public void receivedNodeData(FcpConnection fcpConnection, NodeData nodeData) { @@ -92,7 +92,7 @@ public class FcpAdapter implements FcpListener { /** * {@inheritDoc} - * + * * @see FcpListener#receivedTestDDAReply(FcpConnection, TestDDAReply) */ public void receivedTestDDAReply(FcpConnection fcpConnection, TestDDAReply testDDAReply) { diff --git a/src/net/pterodactylus/fcp/FcpConnectionHandler.java b/src/net/pterodactylus/fcp/FcpConnectionHandler.java index d22e279..dbf0969 100644 --- a/src/net/pterodactylus/fcp/FcpConnectionHandler.java +++ b/src/net/pterodactylus/fcp/FcpConnectionHandler.java @@ -25,7 +25,7 @@ import java.nio.charset.Charset; /** * Handles an FCP connection to a node. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ class FcpConnectionHandler implements Runnable { @@ -45,7 +45,7 @@ class FcpConnectionHandler implements Runnable { /** * Creates a new connection handler that operates on the given connection * and input stream. - * + * * @param fcpConnection * The underlying FCP connection * @param remoteInputStream @@ -119,7 +119,7 @@ class FcpConnectionHandler implements Runnable { /** * Reads bytes from {@link #remoteInputStream} until ‘\r’ or ‘\n’ are * encountered and decodes the read bytes using UTF-8. - * + * * @return The decoded line * @throws IOException * if an I/O error occurs diff --git a/src/net/pterodactylus/fcp/FcpKeyPair.java b/src/net/pterodactylus/fcp/FcpKeyPair.java index 09f2e95..4b9ba05 100644 --- a/src/net/pterodactylus/fcp/FcpKeyPair.java +++ b/src/net/pterodactylus/fcp/FcpKeyPair.java @@ -20,7 +20,7 @@ package net.pterodactylus.fcp; /** * Container for an SSK keypair. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class FcpKeyPair { @@ -33,7 +33,7 @@ public class FcpKeyPair { /** * Creates a new keypair from the given keys. - * + * * @param publicKey * The public key * @param privateKey @@ -46,7 +46,7 @@ public class FcpKeyPair { /** * Returns the public key of this keypair. - * + * * @return The public key */ public String getPublicKey() { @@ -55,7 +55,7 @@ public class FcpKeyPair { /** * Returns the private key of this keypair. - * + * * @return The private key */ public String getPrivateKey() { diff --git a/src/net/pterodactylus/fcp/FcpMessage.java b/src/net/pterodactylus/fcp/FcpMessage.java index 1975f44..b238db3 100644 --- a/src/net/pterodactylus/fcp/FcpMessage.java +++ b/src/net/pterodactylus/fcp/FcpMessage.java @@ -31,7 +31,7 @@ import java.util.Map.Entry; * An FCP message. FCP messages consist of a name, an arbitrary amount of * “fields” (i.e. key-value pairs), a message end marker, and optional payload * data that follows the marker. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class FcpMessage implements Iterable { @@ -50,7 +50,7 @@ public class FcpMessage implements Iterable { /** * Creates a new FCP message with the given name. - * + * * @param name * The name of the FCP message */ @@ -62,7 +62,7 @@ public class FcpMessage implements Iterable { * Creates a new FCP message with the given name and the given payload input * stream. The payload input stream is not read until the message is sent to * the node using {@link FcpConnection#sendMessage(FcpMessage)}. - * + * * @param name * The name of the message * @param payloadInputStream @@ -75,7 +75,7 @@ public class FcpMessage implements Iterable { /** * Returns the name of the message. - * + * * @return The name of the message */ public String getName() { @@ -84,7 +84,7 @@ public class FcpMessage implements Iterable { /** * Checks whether this message has a field with the given name. - * + * * @param field * The name of the field to check for * @return true if the message has a field with the given name, @@ -97,7 +97,7 @@ public class FcpMessage implements Iterable { /** * Sets the field with the given name to the given value. If the field * already exists in this message it is overwritten. - * + * * @param field * The name of the field * @param value @@ -112,7 +112,7 @@ public class FcpMessage implements Iterable { /** * Returns the value of the given field. - * + * * @param field * The name of the field * @return The value of the field, or null if there is no such @@ -124,7 +124,7 @@ public class FcpMessage implements Iterable { /** * Returns all fields of this message. - * + * * @return All fields of this message */ public Map getFields() { @@ -140,7 +140,7 @@ public class FcpMessage implements Iterable { /** * Sets the payload input stream of the message. - * + * * @param payloadInputStream * The payload input stream */ @@ -154,7 +154,7 @@ public class FcpMessage implements Iterable { * payload is written to the given output stream after the message as well. * That means that this method can only be called once because on the second * invocation the payload input stream could not be read (again). - * + * * @param outputStream * The output stream to write the message to * @throws IOException @@ -180,7 +180,7 @@ public class FcpMessage implements Iterable { /** * Writes the given line (followed by {@link #LINEFEED} to the given output * stream, using UTF-8 as encoding. - * + * * @param outputStream * The output stream to write to * @param line diff --git a/src/net/pterodactylus/fcp/FcpTest.java b/src/net/pterodactylus/fcp/FcpTest.java index 6d2d773..6c51848 100644 --- a/src/net/pterodactylus/fcp/FcpTest.java +++ b/src/net/pterodactylus/fcp/FcpTest.java @@ -24,7 +24,7 @@ import junit.framework.TestCase; /** * Tests various commands and the FCP connection. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class FcpTest extends TestCase { @@ -60,7 +60,7 @@ public class FcpTest extends TestCase { /** * Generates an SSK key pair. - * + * * @throws IOException * if an I/O error occurs * @throws InterruptedException diff --git a/src/net/pterodactylus/fcp/FcpUtils.java b/src/net/pterodactylus/fcp/FcpUtils.java index b8b5d84..0957083 100644 --- a/src/net/pterodactylus/fcp/FcpUtils.java +++ b/src/net/pterodactylus/fcp/FcpUtils.java @@ -34,7 +34,7 @@ import java.util.concurrent.atomic.AtomicLong; /** * Helper class with utility methods for the FCP protocol. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class FcpUtils { @@ -44,7 +44,7 @@ public class FcpUtils { /** * Returns a unique identifier. - * + * * @return A unique identifier */ public static String getUniqueIdentifier() { @@ -53,7 +53,7 @@ public class FcpUtils { /** * Parses an integer field, separated by ‘;’ and returns the parsed values. - * + * * @param field * The field to parse * @return An array with the parsed values @@ -74,7 +74,7 @@ public class FcpUtils { /** * Encodes the given integer array into a string, separating the values by * ‘;’. - * + * * @param values * The values to encode * @return The encoded values @@ -93,7 +93,7 @@ public class FcpUtils { /** * Encodes the given string array into a string, separating the values by * ‘;’. - * + * * @param values * The values to encode * @return The encoded values @@ -112,7 +112,7 @@ public class FcpUtils { /** * Tries to parse the given string into an int, returning -1 if * the string can not be parsed. - * + * * @param value * The string to parse * @return The parsed int, or -1 @@ -124,7 +124,7 @@ public class FcpUtils { /** * Tries to parse the given string into an int, returning * defaultValue if the string can not be parsed. - * + * * @param value * The string to parse * @param defaultValue @@ -142,7 +142,7 @@ public class FcpUtils { /** * Tries to parse the given string into an long, returning -1 * if the string can not be parsed. - * + * * @param value * The string to parse * @return The parsed long, or -1 @@ -154,7 +154,7 @@ public class FcpUtils { /** * Tries to parse the given string into an long, returning * defaultValue if the string can not be parsed. - * + * * @param value * The string to parse * @param defaultValue @@ -171,7 +171,7 @@ public class FcpUtils { /** * Closes the given socket. - * + * * @param socket * The socket to close */ @@ -187,7 +187,7 @@ public class FcpUtils { /** * Closes the given Closeable. - * + * * @param closeable * The Closeable to close */ @@ -205,7 +205,7 @@ public class FcpUtils { * Copies as many bytes as possible (i.e. until {@link InputStream#read()} * returns -1) from the source input stream to the destination * output stream. - * + * * @param source * The input stream to read from * @param destination @@ -223,7 +223,7 @@ public class FcpUtils { * much bytes as possible will be copied (i.e. until * {@link InputStream#read()} returns -1 to signal the end of * the stream). - * + * * @param source * The input stream to read from * @param destination @@ -243,7 +243,7 @@ public class FcpUtils { * much bytes as possible will be copied (i.e. until * {@link InputStream#read()} returns -1 to signal the end of * the stream). - * + * * @param source * The input stream to read from * @param destination @@ -275,7 +275,7 @@ public class FcpUtils { /** * This input stream stores the content of another input stream either in a * file or in memory, depending on the length of the input stream. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public static class TempInputStream extends InputStream { @@ -295,7 +295,7 @@ public class FcpUtils { /** * Creates a new temporary input stream that stores the given input * stream in a temporary file. - * + * * @param originalInputStream * The original input stream * @throws IOException @@ -309,7 +309,7 @@ public class FcpUtils { * Creates a new temporary input stream that stores the given input * stream in memory if it is shorter than {@link #MAX_LENGTH_MEMORY}, * otherwise it is stored in a file. - * + * * @param originalInputStream * The original input stream * @param length @@ -325,7 +325,7 @@ public class FcpUtils { * Creates a new temporary input stream that stores the given input * stream in memory if it is shorter than maxMemoryLength, * otherwise it is stored in a file. - * + * * @param originalInputStream * The original input stream * @param length diff --git a/src/net/pterodactylus/fcp/FileEntry.java b/src/net/pterodactylus/fcp/FileEntry.java index 6d0e8a3..f939d78 100644 --- a/src/net/pterodactylus/fcp/FileEntry.java +++ b/src/net/pterodactylus/fcp/FileEntry.java @@ -24,7 +24,7 @@ import java.util.Map; /** * Container class for file entry data. - * + * * @see ClientPutComplexDir#addFileEntry(FileEntry) * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ @@ -38,7 +38,7 @@ public abstract class FileEntry { /** * Creates a new file entry with the given name and upload source. - * + * * @param name * The name of the file * @param uploadFrom @@ -52,7 +52,7 @@ public abstract class FileEntry { /** * Creates a new file entry for a file that should be transmitted to the * node in the payload of the message. - * + * * @param name * The name of the file * @param contentType @@ -70,7 +70,7 @@ public abstract class FileEntry { /** * Creates a new file entry for a file that should be uploaded from disk. - * + * * @param name * The name of the file * @param filename @@ -89,7 +89,7 @@ public abstract class FileEntry { /** * Creates a new file entry for a file that redirects to another URI. - * + * * @param name * The name of the file * @param targetURI @@ -102,7 +102,7 @@ public abstract class FileEntry { /** * Returns the fields for this file entry. - * + * * @return The fields for this file entry */ abstract Map getFields(); @@ -110,7 +110,7 @@ public abstract class FileEntry { /** * A file entry for a file that should be transmitted in the payload of the * {@link ClientPutComplexDir} message. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ static class DirectFileEntry extends FileEntry { @@ -126,7 +126,7 @@ public abstract class FileEntry { /** * Creates a new direct file entry with content type auto-detection. - * + * * @param name * The name of the file * @param length @@ -140,7 +140,7 @@ public abstract class FileEntry { /** * Creates a new direct file entry. - * + * * @param name * The name of the file * @param contentType @@ -175,7 +175,7 @@ public abstract class FileEntry { /** * Returns the input stream of the file. - * + * * @return The input stream of the file */ InputStream getInputStream() { @@ -186,7 +186,7 @@ public abstract class FileEntry { /** * A file entry for a file that should be uploaded from the disk. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ static class DiskFileEntry extends FileEntry { @@ -202,7 +202,7 @@ public abstract class FileEntry { /** * Creates a new disk file entry. - * + * * @param name * The name of the file * @param filename @@ -216,7 +216,7 @@ public abstract class FileEntry { /** * Creates a new disk file entry. - * + * * @param name * The name of the file * @param filename @@ -256,7 +256,7 @@ public abstract class FileEntry { /** * A file entry for a file that redirects to another URI. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ static class RedirectFileEntry extends FileEntry { @@ -266,7 +266,7 @@ public abstract class FileEntry { /** * Creates a new redirect file entry. - * + * * @param name * The name of the file * @param targetURI diff --git a/src/net/pterodactylus/fcp/FinishedCompression.java b/src/net/pterodactylus/fcp/FinishedCompression.java index ca9a6cc..9d09d62 100644 --- a/src/net/pterodactylus/fcp/FinishedCompression.java +++ b/src/net/pterodactylus/fcp/FinishedCompression.java @@ -21,7 +21,7 @@ package net.pterodactylus.fcp; /** * A “FinishedCompression” message signals the client that the compression of * the request data has been finished. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class FinishedCompression extends BaseMessage { @@ -29,7 +29,7 @@ public class FinishedCompression extends BaseMessage { /** * Creates a new “FinishedCompression” message that wraps the received * message. - * + * * @param receivedMessage * The message that was recevied */ @@ -39,7 +39,7 @@ public class FinishedCompression extends BaseMessage { /** * Returns the identifier of the request. - * + * * @return The identifier of the request */ public String getIdentifier() { @@ -48,7 +48,7 @@ public class FinishedCompression extends BaseMessage { /** * Returns the ID of the codec that was used for compression. - * + * * @return The ID of the codec that was used for compression */ public int getCodec() { @@ -57,7 +57,7 @@ public class FinishedCompression extends BaseMessage { /** * Returns the original size of the data (i.e. before compression). - * + * * @return The original size of the data */ public long getOriginalSize() { @@ -66,7 +66,7 @@ public class FinishedCompression extends BaseMessage { /** * Returns the compressed size of the data (i.e. after compression). - * + * * @return The compressed size of the data */ public long getCompressedSize() { diff --git a/src/net/pterodactylus/fcp/GenerateSSK.java b/src/net/pterodactylus/fcp/GenerateSSK.java index acab898..5e33c6c 100644 --- a/src/net/pterodactylus/fcp/GenerateSSK.java +++ b/src/net/pterodactylus/fcp/GenerateSSK.java @@ -21,7 +21,7 @@ package net.pterodactylus.fcp; /** * A “GenerateSSK” message. This message tells the node to generate a new SSK * key pair. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class GenerateSSK extends FcpMessage { @@ -35,7 +35,7 @@ public class GenerateSSK extends FcpMessage { /** * Creates a new “GenerateSSK” message with the given client identifier. - * + * * @param clientIdentifier * The client identifier */ diff --git a/src/net/pterodactylus/fcp/GetConfig.java b/src/net/pterodactylus/fcp/GetConfig.java index 5870a12..11e4cc6 100644 --- a/src/net/pterodactylus/fcp/GetConfig.java +++ b/src/net/pterodactylus/fcp/GetConfig.java @@ -21,7 +21,7 @@ package net.pterodactylus.fcp; /** * The “GetConfig” command tells the node to send its configuration to the * client. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class GetConfig extends FcpMessage { @@ -36,7 +36,7 @@ public class GetConfig extends FcpMessage { /** * Sets whether the {@link ConfigData} result message shall include the * current values. - * + * * @param withCurrent * true to include current values in the result, * false otherwise @@ -48,7 +48,7 @@ public class GetConfig extends FcpMessage { /** * Sets whether the {@link ConfigData} result message shall include the * short descriptions. - * + * * @param withShortDescription * true to include the short descriptions in the * result, false otherwise @@ -60,7 +60,7 @@ public class GetConfig extends FcpMessage { /** * Sets whether the {@link ConfigData} result message shall include the long * descriptions. - * + * * @param withLongDescription * true to include the long descriptions in the * result, false otherwise @@ -72,7 +72,7 @@ public class GetConfig extends FcpMessage { /** * Sets whether the {@link ConfigData} result message shall include the data * types. - * + * * @param withDataTypes * true to include the data types in the result, * false otherwise @@ -84,7 +84,7 @@ public class GetConfig extends FcpMessage { /** * Sets whether the {@link ConfigData} result message shall include the * defaults. - * + * * @param setWithDefaults * true to include the defaults in the result, * false otherwise @@ -96,7 +96,7 @@ public class GetConfig extends FcpMessage { /** * Sets whether the {@link ConfigData} result message shall include the sort * order. - * + * * @param withSortOrder * true to include the sort order in the result, * false otherwise @@ -108,7 +108,7 @@ public class GetConfig extends FcpMessage { /** * Sets whether the {@link ConfigData} result message shall include the * expert flag. - * + * * @param withExpertFlag * true to include the expert flag in the result, * false otherwise @@ -120,7 +120,7 @@ public class GetConfig extends FcpMessage { /** * Sets whether the {@link ConfigData} result message shall include the * force-write flag. - * + * * @param withForceWriteFlag * true to include the force-write flag in the * result, false otherwise diff --git a/src/net/pterodactylus/fcp/GetNode.java b/src/net/pterodactylus/fcp/GetNode.java index f2d74ab..799b44b 100644 --- a/src/net/pterodactylus/fcp/GetNode.java +++ b/src/net/pterodactylus/fcp/GetNode.java @@ -21,7 +21,7 @@ package net.pterodactylus.fcp; /** * The “GetNode” command returns the darknet or opennet noderef of the node, * optionally including private and volatile data. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class GetNode extends FcpMessage { @@ -38,7 +38,7 @@ public class GetNode extends FcpMessage { * including private and volatile data, if requested. If any of the Boolean * parameters are null the parameter is ignored and the node’s * default value is used. - * + * * @param giveOpennetRef * true to request the opennet noderef, * false for darknet diff --git a/src/net/pterodactylus/fcp/GetPluginInfo.java b/src/net/pterodactylus/fcp/GetPluginInfo.java index aaf9705..8ad5392 100644 --- a/src/net/pterodactylus/fcp/GetPluginInfo.java +++ b/src/net/pterodactylus/fcp/GetPluginInfo.java @@ -21,14 +21,14 @@ package net.pterodactylus.fcp; /** * The “GetPluginInfo” message requests information about a plugin from the * node, which will response with a {@link PluginInfo} message. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class GetPluginInfo extends FcpMessage { /** * Creates a new “GetPluginInfo” message. - * + * * @param pluginName * The name of the plugin * @param identifier @@ -42,7 +42,7 @@ public class GetPluginInfo extends FcpMessage { /** * Sets whether detailed information about the plugin is wanted. - * + * * @param detailed * true to request detailed information about the * plugin, false otherwise diff --git a/src/net/pterodactylus/fcp/GetRequestStatus.java b/src/net/pterodactylus/fcp/GetRequestStatus.java index b4a677f..5e2d63b 100644 --- a/src/net/pterodactylus/fcp/GetRequestStatus.java +++ b/src/net/pterodactylus/fcp/GetRequestStatus.java @@ -22,14 +22,14 @@ package net.pterodactylus.fcp; * The “GetRequestStatus” message is used request status information about a * running request. It is also the only way to trigger a download of a persisted * completed {@link ClientGet} with a return type of {@link ReturnType#direct}. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class GetRequestStatus extends FcpMessage { /** * Creates a new “GetRequestStatus” message. - * + * * @param identifier * The identifier of the request */ @@ -40,7 +40,7 @@ public class GetRequestStatus extends FcpMessage { /** * Sets whether the request is on the global queue. - * + * * @param global * true if the request is on the global queue, * false if it is on the client-local queue @@ -52,7 +52,7 @@ public class GetRequestStatus extends FcpMessage { /** * Sets whether the omit the transmission of the request data in a * {@link AllData} message. - * + * * @param onlyData * true to skip transmission of data, * false to download data diff --git a/src/net/pterodactylus/fcp/IdentifierCollision.java b/src/net/pterodactylus/fcp/IdentifierCollision.java index 981045d..bc96a70 100644 --- a/src/net/pterodactylus/fcp/IdentifierCollision.java +++ b/src/net/pterodactylus/fcp/IdentifierCollision.java @@ -21,7 +21,7 @@ package net.pterodactylus.fcp; /** * The “IdentifierCollision” message signals the client that the identifier * chosen for a request is already existing. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class IdentifierCollision extends BaseMessage { @@ -29,7 +29,7 @@ public class IdentifierCollision extends BaseMessage { /** * Creates a new “IdentifierCollision” message that wraps the received * message. - * + * * @param receivedMessage * The received message */ @@ -39,7 +39,7 @@ public class IdentifierCollision extends BaseMessage { /** * Returns the identifier of the request. - * + * * @return The identifier of the request */ public String getIdentifier() { @@ -48,7 +48,7 @@ public class IdentifierCollision extends BaseMessage { /** * Returns whether the request is on the global queue. - * + * * @return true if the request is on the global queue, * false if it is on the client-local queue */ diff --git a/src/net/pterodactylus/fcp/ListPeer.java b/src/net/pterodactylus/fcp/ListPeer.java index 8f866ca..f16f385 100644 --- a/src/net/pterodactylus/fcp/ListPeer.java +++ b/src/net/pterodactylus/fcp/ListPeer.java @@ -20,7 +20,7 @@ package net.pterodactylus.fcp; /** * The “ListPeer” request asks the node about the details of a given peer. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class ListPeer extends FcpMessage { @@ -30,7 +30,7 @@ public class ListPeer extends FcpMessage { * specified by nodeIdentifier. nodeIdentifier can * be of several formats: The node’s name, its identity, or its IP address * and port (connection with a ‘:’). - * + * * @param nodeIdentifier * The identifier of the node to get details about */ diff --git a/src/net/pterodactylus/fcp/ListPeerNotes.java b/src/net/pterodactylus/fcp/ListPeerNotes.java index 0fff5e7..82e3399 100644 --- a/src/net/pterodactylus/fcp/ListPeerNotes.java +++ b/src/net/pterodactylus/fcp/ListPeerNotes.java @@ -21,7 +21,7 @@ package net.pterodactylus.fcp; /** * A “ListPeerNodes” request tells the node to list all notes that have been * entered for a node. Note that notes are only supported for darknet nodes. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class ListPeerNotes extends FcpMessage { @@ -29,7 +29,7 @@ public class ListPeerNotes extends FcpMessage { /** * Creates a new “ListPeerNotes” request that lists all notes of the * specified node. - * + * * @param nodeIdentifier * The identifier of the node */ diff --git a/src/net/pterodactylus/fcp/ListPeers.java b/src/net/pterodactylus/fcp/ListPeers.java index 958e9d6..b0cbd1b 100644 --- a/src/net/pterodactylus/fcp/ListPeers.java +++ b/src/net/pterodactylus/fcp/ListPeers.java @@ -20,7 +20,7 @@ package net.pterodactylus.fcp; /** * The “ListPeer” requests asks the node for a list of all peers it has. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class ListPeers extends FcpMessage { @@ -28,7 +28,7 @@ public class ListPeers extends FcpMessage { /** * Creates a new “ListPeers” request that only includes basic data of the * peers. - * + * * @param identifier * The identifier of the request */ @@ -38,7 +38,7 @@ public class ListPeers extends FcpMessage { /** * Creates a new “ListPeers” request that includes wanted data of the peers. - * + * * @param identifier * The identifier of the request * @param withMetadata diff --git a/src/net/pterodactylus/fcp/ListPersistentRequests.java b/src/net/pterodactylus/fcp/ListPersistentRequests.java index 2b55fdc..645205c 100644 --- a/src/net/pterodactylus/fcp/ListPersistentRequests.java +++ b/src/net/pterodactylus/fcp/ListPersistentRequests.java @@ -22,7 +22,7 @@ package net.pterodactylus.fcp; * Command to tell the node to list all persistent requests from the current * queue, which is either the global queue or the client-local queue, depending * on your {@link WatchGlobal} status. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class ListPersistentRequests extends FcpMessage { diff --git a/src/net/pterodactylus/fcp/ModifyConfig.java b/src/net/pterodactylus/fcp/ModifyConfig.java index 7bfc0a8..412b818 100644 --- a/src/net/pterodactylus/fcp/ModifyConfig.java +++ b/src/net/pterodactylus/fcp/ModifyConfig.java @@ -20,7 +20,7 @@ package net.pterodactylus.fcp; /** * The “ModifyConfig” message is used to change the node’s configuration. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class ModifyConfig extends FcpMessage { @@ -34,7 +34,7 @@ public class ModifyConfig extends FcpMessage { /** * Sets the option with the given name to the given value. - * + * * @param option * The name of the option * @param value diff --git a/src/net/pterodactylus/fcp/ModifyPeer.java b/src/net/pterodactylus/fcp/ModifyPeer.java index 1bed3e1..dc9af6b 100644 --- a/src/net/pterodactylus/fcp/ModifyPeer.java +++ b/src/net/pterodactylus/fcp/ModifyPeer.java @@ -20,7 +20,7 @@ package net.pterodactylus.fcp; /** * The “ModifyPeer” request lets you modify certain properties of a peer. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class ModifyPeer extends FcpMessage { @@ -28,7 +28,7 @@ public class ModifyPeer extends FcpMessage { /** * Creates a new “ModifyPeer” request. All Boolean parameters may be null to * not influence the current setting. - * + * * @param nodeIdentifier * The identifier of the node, i.e. name, identity, or IP address * and port diff --git a/src/net/pterodactylus/fcp/ModifyPeerNote.java b/src/net/pterodactylus/fcp/ModifyPeerNote.java index a05afd7..dbb2ea7 100644 --- a/src/net/pterodactylus/fcp/ModifyPeerNote.java +++ b/src/net/pterodactylus/fcp/ModifyPeerNote.java @@ -20,7 +20,7 @@ package net.pterodactylus.fcp; /** * The “ModifyPeerNote” command modifies a peer note. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class ModifyPeerNote extends FcpMessage { @@ -28,7 +28,7 @@ public class ModifyPeerNote extends FcpMessage { /** * Creates a new “ModifyPeerNote” request that changes peer note of the * given type and node to the given text. - * + * * @see PeerNote * @param nodeIdentifier * The identifier of the node, i.e. name, identity, or IP address diff --git a/src/net/pterodactylus/fcp/ModifyPersistentRequest.java b/src/net/pterodactylus/fcp/ModifyPersistentRequest.java index 767d3e1..cc71829 100644 --- a/src/net/pterodactylus/fcp/ModifyPersistentRequest.java +++ b/src/net/pterodactylus/fcp/ModifyPersistentRequest.java @@ -21,7 +21,7 @@ package net.pterodactylus.fcp; /** * A “ModifyPersistentRequest” is used to modify certain properties of a * persistent request while it is running. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class ModifyPersistentRequest extends FcpMessage { @@ -29,7 +29,7 @@ public class ModifyPersistentRequest extends FcpMessage { /** * Creates a new “ModifyPersistentRequest” that changes the specified * request. - * + * * @param requestIdentifier * The identifier of the request * @param global @@ -44,7 +44,7 @@ public class ModifyPersistentRequest extends FcpMessage { /** * Sets the new client token of the request. - * + * * @param newClientToken * The new client token of the request */ @@ -54,7 +54,7 @@ public class ModifyPersistentRequest extends FcpMessage { /** * Sets the new priority of the request. - * + * * @param newPriority * The new priority of the request */ diff --git a/src/net/pterodactylus/fcp/NodeData.java b/src/net/pterodactylus/fcp/NodeData.java index 05ee412..5425833 100644 --- a/src/net/pterodactylus/fcp/NodeData.java +++ b/src/net/pterodactylus/fcp/NodeData.java @@ -20,7 +20,7 @@ package net.pterodactylus.fcp; /** * The “NodeData” contains the noderef of the node, along with additional data. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class NodeData extends BaseMessage { @@ -30,7 +30,7 @@ public class NodeData extends BaseMessage { /** * Creates a new “NodeData” message that wraps the received message. - * + * * @param receivedMessage * The received message */ @@ -41,7 +41,7 @@ public class NodeData extends BaseMessage { /** * Returns the noderef of the node. - * + * * @return The noderef of the node */ public NodeRef getNodeRef() { @@ -51,7 +51,7 @@ public class NodeData extends BaseMessage { /** * Returns the last good version, i.e. the oldest version the node will * connect to. - * + * * @return The last good version */ public Version getLastGoodVersion() { @@ -60,7 +60,7 @@ public class NodeData extends BaseMessage { /** * Returns the signature of the noderef. - * + * * @return The signature of the noderef */ public String getSignature() { @@ -69,7 +69,7 @@ public class NodeData extends BaseMessage { /** * Returns whether the noderef is the opennet noderef of the node - * + * * @return true if the noderef is the opennet noderef of the * node, false otherwise */ @@ -79,7 +79,7 @@ public class NodeData extends BaseMessage { /** * Returns the identity of the node - * + * * @return The identity of the node */ public String getIdentity() { @@ -88,7 +88,7 @@ public class NodeData extends BaseMessage { /** * Returns the name of the node. - * + * * @return The name of the node */ public String getMyName() { @@ -97,7 +97,7 @@ public class NodeData extends BaseMessage { /** * Returns the version of the node. - * + * * @return The version of the node */ public Version getVersion() { @@ -106,7 +106,7 @@ public class NodeData extends BaseMessage { /** * Returns IP addresses and port number of the node. - * + * * @return The IP addresses and port numbers of the node */ public String getPhysicalUDP() { @@ -115,7 +115,7 @@ public class NodeData extends BaseMessage { /** * Returns the ARK of the node. - * + * * @return The ARK of the node */ public ARK getARK() { @@ -124,7 +124,7 @@ public class NodeData extends BaseMessage { /** * Returns the public key of the node. - * + * * @return The public key of the node */ public String getDSAPublicKey() { @@ -133,7 +133,7 @@ public class NodeData extends BaseMessage { /** * Returns the private key of the node. - * + * * @return The private key of the node */ public String getDSKPrivateKey() { @@ -142,7 +142,7 @@ public class NodeData extends BaseMessage { /** * Returns the DSA group of the node. - * + * * @return The DSA group of the node */ public DSAGroup getDSAGroup() { @@ -151,7 +151,7 @@ public class NodeData extends BaseMessage { /** * Returns the negotiation types supported by the node. - * + * * @return The node’s supported negotiation types */ public int[] getNegotiationTypes() { @@ -163,7 +163,7 @@ public class NodeData extends BaseMessage { * is prepended with “volatile.” so if you want to get the value of the * field with the name “volatile.freeJavaMemory” you only need to specify * “freeJavaMemory”. - * + * * @param field * The name of the field * @return The value of the field, or null if there is no such diff --git a/src/net/pterodactylus/fcp/NodeHello.java b/src/net/pterodactylus/fcp/NodeHello.java index ecb1817..01b0515 100644 --- a/src/net/pterodactylus/fcp/NodeHello.java +++ b/src/net/pterodactylus/fcp/NodeHello.java @@ -20,14 +20,14 @@ package net.pterodactylus.fcp; /** * Some convenience methods for parsing a “NodeHello” message from the node. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class NodeHello extends BaseMessage { /** * Createa a new “NodeHello” message that wraps the received message. - * + * * @param receivedMessage * The received FCP message */ @@ -38,7 +38,7 @@ public class NodeHello extends BaseMessage { /** * Returns the build of the node. This may not be a number but also a string * like “@custom@” in case you built the node yourself. - * + * * @return The build of the node */ public String getBuild() { @@ -48,7 +48,7 @@ public class NodeHello extends BaseMessage { /** * Returns the build number of the node. This may not be a number but also a * string like “@custom@” in case you built the node yourself. - * + * * @return The build number of the node, or -1 if the build * number could not be determined */ @@ -58,7 +58,7 @@ public class NodeHello extends BaseMessage { /** * Returns the number of compression codecs. - * + * * @return The number of compression codecs */ public String getCompressionCodecs() { @@ -67,7 +67,7 @@ public class NodeHello extends BaseMessage { /** * Returns the number of compression codecs. - * + * * @return The number of compression codecs, or -1 if the * number of compression codecs could not be determined */ @@ -77,7 +77,7 @@ public class NodeHello extends BaseMessage { /** * Returns the unique connection identifier. - * + * * @return The connection identifier */ public String getConnectionIdentifier() { @@ -86,7 +86,7 @@ public class NodeHello extends BaseMessage { /** * Returns the build of the external library file. - * + * * @return The build of the external library file */ public String getExtBuild() { @@ -95,7 +95,7 @@ public class NodeHello extends BaseMessage { /** * Returns the build number of the external library file. - * + * * @return The build number of the external library file, or -1 * if the build number could not be determined */ @@ -105,7 +105,7 @@ public class NodeHello extends BaseMessage { /** * Returns the revision of the external library file. - * + * * @return The revision of the external library file */ public String getExtRevision() { @@ -114,7 +114,7 @@ public class NodeHello extends BaseMessage { /** * Returns the revision number of the external library file. - * + * * @return The revision number of the external library file, or * -1 if the revision number could not be determined */ @@ -124,7 +124,7 @@ public class NodeHello extends BaseMessage { /** * Returns the FCP version the node speaks. - * + * * @return The FCP version the node speaks */ public String getFCPVersion() { @@ -134,7 +134,7 @@ public class NodeHello extends BaseMessage { /** * Returns the make of the node, e.g. “Fred” (freenet reference * implementation). - * + * * @return The make of the node */ public String getNode() { @@ -143,7 +143,7 @@ public class NodeHello extends BaseMessage { /** * Returns the language of the node as 2-letter code, e.g. “en” or “de”. - * + * * @return The language of the node */ public String getNodeLanguage() { @@ -152,7 +152,7 @@ public class NodeHello extends BaseMessage { /** * Returns the revision of the node. - * + * * @return The revision of the node */ public String getRevision() { @@ -161,7 +161,7 @@ public class NodeHello extends BaseMessage { /** * Returns the revision number of the node. - * + * * @return The revision number of the node, or -1 if the * revision number coult not be determined */ @@ -171,7 +171,7 @@ public class NodeHello extends BaseMessage { /** * Returns whether the node is currently is testnet mode. - * + * * @return true if the node is currently in testnet mode, * false otherwise */ @@ -181,7 +181,7 @@ public class NodeHello extends BaseMessage { /** * Returns the version of the node. - * + * * @return The version of the node */ public String getVersion() { diff --git a/src/net/pterodactylus/fcp/NodeRef.java b/src/net/pterodactylus/fcp/NodeRef.java index 728f9e5..64ca56c 100644 --- a/src/net/pterodactylus/fcp/NodeRef.java +++ b/src/net/pterodactylus/fcp/NodeRef.java @@ -21,7 +21,7 @@ package net.pterodactylus.fcp; /** * A reference for a node. The noderef contains all data that is necessary to * establish a trusted and secure connection to the node. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class NodeRef { @@ -75,7 +75,7 @@ public class NodeRef { /** * Creates a new noderef that is initialized with fields from the given * message. - * + * * @param fromMessage * The message to get initial values for the noderef from */ @@ -99,7 +99,7 @@ public class NodeRef { /** * Returns the identity of the node. - * + * * @return The identity of the node */ public String getIdentity() { @@ -108,7 +108,7 @@ public class NodeRef { /** * Sets the identity of the node. - * + * * @param identity * The identity of the node */ @@ -118,7 +118,7 @@ public class NodeRef { /** * Returns whether the node is an opennet peer. - * + * * @return true if the node is an opennet peer, * false otherwise */ @@ -128,7 +128,7 @@ public class NodeRef { /** * Sets whether the node is an opennet peer. - * + * * @param opennet * true if the node is an opennet peer, * false otherwise @@ -140,7 +140,7 @@ public class NodeRef { /** * Returns the name of the node. If the node is an opennet peer, it will not * have a name! - * + * * @return The name of the node, or null if the node is an * opennet peer */ @@ -150,7 +150,7 @@ public class NodeRef { /** * Sets the name of the peer. - * + * * @param name * The name of the peer */ @@ -160,7 +160,7 @@ public class NodeRef { /** * Returns the location of the node. - * + * * @return The location of the node */ public double getLocation() { @@ -169,7 +169,7 @@ public class NodeRef { /** * Sets the location of the node - * + * * @param location * The location of the node */ @@ -179,7 +179,7 @@ public class NodeRef { /** * Returns the IP addresses and port numbers of the node. - * + * * @return The IP addresses and port numbers of the node */ public String getPhysicalUDP() { @@ -188,7 +188,7 @@ public class NodeRef { /** * Sets the IP addresses and port numbers of the node. - * + * * @param physicalUDP * The IP addresses and port numbers of the node */ @@ -198,7 +198,7 @@ public class NodeRef { /** * Returns the ARK of the node. - * + * * @return The ARK of the node */ public ARK getARK() { @@ -207,7 +207,7 @@ public class NodeRef { /** * Sets the ARK of the node. - * + * * @param ark * The ARK of the node */ @@ -217,7 +217,7 @@ public class NodeRef { /** * Returns the public DSA key of the node. - * + * * @return The public DSA key of the node */ public String getDSAPublicKey() { @@ -226,7 +226,7 @@ public class NodeRef { /** * Sets the public DSA key of the node. - * + * * @param dsaPublicKey * The public DSA key of the node */ @@ -236,7 +236,7 @@ public class NodeRef { /** * Returns the DSA group of the node. - * + * * @return The DSA group of the node */ public DSAGroup getDSAGroup() { @@ -245,7 +245,7 @@ public class NodeRef { /** * Sets the DSA group of the node. - * + * * @param dsaGroup * The DSA group of the node */ @@ -255,7 +255,7 @@ public class NodeRef { /** * Returns the negotiation types supported by the node. - * + * * @return The node’s supported negotiation types */ public int[] getNegotiationTypes() { @@ -264,7 +264,7 @@ public class NodeRef { /** * Sets the negotiation types supported by the node. - * + * * @param negotiationTypes * The node’s supported negotiation types */ @@ -274,7 +274,7 @@ public class NodeRef { /** * Returns the version of the node. - * + * * @return The version of the node */ public Version getVersion() { @@ -283,7 +283,7 @@ public class NodeRef { /** * Sets the version of the node. - * + * * @param version * The version of the node */ @@ -293,7 +293,7 @@ public class NodeRef { /** * Returns the last good version of the node. - * + * * @return The oldest version the node will connect to */ public Version getLastGoodVersion() { @@ -302,7 +302,7 @@ public class NodeRef { /** * Sets the last good version of the node. - * + * * @param lastGoodVersion * The oldest version the node will connect to */ @@ -312,7 +312,7 @@ public class NodeRef { /** * Returns whether the node is a testnet node. - * + * * @return true if the node is a testnet node, * false otherwise */ @@ -322,7 +322,7 @@ public class NodeRef { /** * Sets whether this node is a testnet node. - * + * * @param testnet * true if the node is a testnet node, * false otherwise @@ -333,7 +333,7 @@ public class NodeRef { /** * Returns the signature of the noderef. - * + * * @return The signature of the noderef */ public String getSignature() { @@ -342,7 +342,7 @@ public class NodeRef { /** * Sets the signature of the noderef. - * + * * @param signature * The signature of the noderef */ diff --git a/src/net/pterodactylus/fcp/PeerRemoved.java b/src/net/pterodactylus/fcp/PeerRemoved.java index 643bbbd..61aa08d 100644 --- a/src/net/pterodactylus/fcp/PeerRemoved.java +++ b/src/net/pterodactylus/fcp/PeerRemoved.java @@ -20,14 +20,14 @@ package net.pterodactylus.fcp; /** * A “PeerRemoved” message is sent by the node when a peer has been removed. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class PeerRemoved extends BaseMessage { /** * Creates a new “PeerRemoved” message that wraps the received message. - * + * * @param receivedMessage * The received message */ @@ -37,7 +37,7 @@ public class PeerRemoved extends BaseMessage { /** * Returns the identity of the removed peer. - * + * * @return The identity of the removed peer */ public String getIdentity() { @@ -46,7 +46,7 @@ public class PeerRemoved extends BaseMessage { /** * Returns the node identifier of the removed peer. - * + * * @return The node identifier of the removed peer */ public String getNodeIdentifier() { diff --git a/src/net/pterodactylus/fcp/Persistence.java b/src/net/pterodactylus/fcp/Persistence.java index c5975ec..44c5e62 100644 --- a/src/net/pterodactylus/fcp/Persistence.java +++ b/src/net/pterodactylus/fcp/Persistence.java @@ -20,7 +20,7 @@ package net.pterodactylus.fcp; /** * Convenience class for persistence values. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public enum Persistence { diff --git a/src/net/pterodactylus/fcp/PersistentGet.java b/src/net/pterodactylus/fcp/PersistentGet.java index 1d04846..7489801 100644 --- a/src/net/pterodactylus/fcp/PersistentGet.java +++ b/src/net/pterodactylus/fcp/PersistentGet.java @@ -21,14 +21,14 @@ package net.pterodactylus.fcp; /** * The “PersistentGet” message is sent to the client to inform it about a * persistent download, either in the client-local queue or in the global queue. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class PersistentGet extends BaseMessage { /** * Creates a new “PersistentGet” message that wraps the received message. - * + * * @param receivedMessage * The received message */ @@ -38,7 +38,7 @@ public class PersistentGet extends BaseMessage { /** * Returns the identifier of the request. - * + * * @return The identifier of the request */ public String getIdentifier() { @@ -47,7 +47,7 @@ public class PersistentGet extends BaseMessage { /** * Returns the URI of the request. - * + * * @return The URI of the request */ public String getURI() { @@ -56,7 +56,7 @@ public class PersistentGet extends BaseMessage { /** * Returns the verbosity of the request. - * + * * @return The verbosity of the request */ public Verbosity getVerbosity() { @@ -65,7 +65,7 @@ public class PersistentGet extends BaseMessage { /** * Returns the return type of the request. - * + * * @return The return type of the request */ public ReturnType getReturnType() { @@ -79,7 +79,7 @@ public class PersistentGet extends BaseMessage { /** * Returns the name of the file the data is downloaded to. This field will * only be set if {@link #getReturnType()} is {@link ReturnType#disk}. - * + * * @return The name of the file the data is downloaded to */ public String getFilename() { @@ -89,7 +89,7 @@ public class PersistentGet extends BaseMessage { /** * Returns the name of the temporary file. This field will only be set if * {@link #getReturnType()} is {@link ReturnType#disk}. - * + * * @return The name of the temporary file */ public String getTempFilename() { @@ -98,7 +98,7 @@ public class PersistentGet extends BaseMessage { /** * Returns the client token of the request. - * + * * @return The client token of the request */ public String getClientToken() { @@ -107,7 +107,7 @@ public class PersistentGet extends BaseMessage { /** * Returns the priority of the request. - * + * * @return The priority of the request */ public Priority getPriority() { @@ -116,7 +116,7 @@ public class PersistentGet extends BaseMessage { /** * Returns the persistence of the request. - * + * * @return The persistence of the request, or {@link Persistence#unknown} if * the persistence could not be parsed */ @@ -131,7 +131,7 @@ public class PersistentGet extends BaseMessage { /** * Returns whether this request is on the global queue or on the * client-local queue. - * + * * @return true if the request is on the global queue, * false if the request is on the client-local queue */ @@ -141,7 +141,7 @@ public class PersistentGet extends BaseMessage { /** * Returns the maximum number of retries for a failed block. - * + * * @return The maximum number of retries for a failed block, -1 * for endless retries, -2 if the number could not be * parsed diff --git a/src/net/pterodactylus/fcp/PersistentPut.java b/src/net/pterodactylus/fcp/PersistentPut.java index 892bd81..383ea93 100644 --- a/src/net/pterodactylus/fcp/PersistentPut.java +++ b/src/net/pterodactylus/fcp/PersistentPut.java @@ -21,14 +21,14 @@ package net.pterodactylus.fcp; /** * A “PersistentPut” message notifies a client about a persistent * {@link ClientPut} request. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class PersistentPut extends BaseMessage { /** * Creates a new “PersistentPut” message that wraps the received message. - * + * * @param receivedMessage * The received message */ @@ -38,7 +38,7 @@ public class PersistentPut extends BaseMessage { /** * Returns the client token of the request. - * + * * @return The client token of the request */ public String getClientToken() { @@ -47,7 +47,7 @@ public class PersistentPut extends BaseMessage { /** * Returns the data length of the request. - * + * * @return The data length of the request, or -1 if the length * could not be parsed */ @@ -57,7 +57,7 @@ public class PersistentPut extends BaseMessage { /** * Returns whether the request is on the global queue. - * + * * @return true if the request is on the global queue, * false otherwise */ @@ -67,7 +67,7 @@ public class PersistentPut extends BaseMessage { /** * Returns the identifier of the request. - * + * * @return The identifier of the request */ public String getIdentifier() { @@ -77,7 +77,7 @@ public class PersistentPut extends BaseMessage { /** * Returns the maximum number of retries for failed blocks. When * -1 is returned each block is tried forever. - * + * * @return The maximum number of retries for failed blocks, or * -1 for unlimited retries, or -2 if the * number of retries could not be parsed @@ -88,7 +88,7 @@ public class PersistentPut extends BaseMessage { /** * Returns the content type of the data. - * + * * @return The content type */ public String getMetadataContentType() { @@ -97,7 +97,7 @@ public class PersistentPut extends BaseMessage { /** * Returns the persistence of the request. - * + * * @return The persistence of the request */ public Persistence getPersistence() { @@ -106,7 +106,7 @@ public class PersistentPut extends BaseMessage { /** * Returns the priority of the request. - * + * * @return The priority of the request, or {@link Priority#unknown} if the * priority could not be parsed */ @@ -116,7 +116,7 @@ public class PersistentPut extends BaseMessage { /** * Returns whether this request has started. - * + * * @return true if the request has started, false * otherwise */ @@ -126,7 +126,7 @@ public class PersistentPut extends BaseMessage { /** * Returns the target filename of the request. - * + * * @return The target filename of the request */ public String getTargetFilename() { @@ -135,7 +135,7 @@ public class PersistentPut extends BaseMessage { /** * Returns the upload source of the request. - * + * * @return The upload source of the request */ public UploadFrom getUploadFrom() { @@ -144,7 +144,7 @@ public class PersistentPut extends BaseMessage { /** * Returns the target URI of the request. - * + * * @return The target URI of the request */ public String getURI() { @@ -153,7 +153,7 @@ public class PersistentPut extends BaseMessage { /** * Returns the verbosity of the request. - * + * * @return The verbosity of the request */ public Verbosity getVerbosity() { diff --git a/src/net/pterodactylus/fcp/PersistentRequestModified.java b/src/net/pterodactylus/fcp/PersistentRequestModified.java index 699daa4..ea8d1ac 100644 --- a/src/net/pterodactylus/fcp/PersistentRequestModified.java +++ b/src/net/pterodactylus/fcp/PersistentRequestModified.java @@ -21,7 +21,7 @@ package net.pterodactylus.fcp; /** * The “PersistentRequestModified” message is a reply to * {@link ModifyPersistentRequest}. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class PersistentRequestModified extends BaseMessage { @@ -29,7 +29,7 @@ public class PersistentRequestModified extends BaseMessage { /** * Creates a new “PersistentRequestModified” message that wraps the received * message. - * + * * @param receivedMessage * The received message */ @@ -39,7 +39,7 @@ public class PersistentRequestModified extends BaseMessage { /** * Returns the identifier of the changed request. - * + * * @return The identifier of the request */ public String getIdentifier() { @@ -48,7 +48,7 @@ public class PersistentRequestModified extends BaseMessage { /** * Returns whether the request is on the global queue. - * + * * @return true if the request is on the global queue, * false if it is on a client-local queue */ @@ -58,7 +58,7 @@ public class PersistentRequestModified extends BaseMessage { /** * Returns the client token, if it was changed. - * + * * @return The new client token, or null if the client token * was not changed */ @@ -68,7 +68,7 @@ public class PersistentRequestModified extends BaseMessage { /** * Returns the priority of the request, if it was changed. - * + * * @return The new priority of the request, or {@link Priority#unknown} if * the priority was not changed */ diff --git a/src/net/pterodactylus/fcp/PersistentRequestRemoved.java b/src/net/pterodactylus/fcp/PersistentRequestRemoved.java index e765461..154c88c 100644 --- a/src/net/pterodactylus/fcp/PersistentRequestRemoved.java +++ b/src/net/pterodactylus/fcp/PersistentRequestRemoved.java @@ -21,7 +21,7 @@ package net.pterodactylus.fcp; /** * A “PersistentRequestRemoved” message signals that a persistent request was * removed from either the global or the client-local queue. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class PersistentRequestRemoved extends BaseMessage { @@ -29,7 +29,7 @@ public class PersistentRequestRemoved extends BaseMessage { /** * Creates a new “PersistentRequestRemoved” message that wraps the received * message. - * + * * @param receivedMessage * The received message */ @@ -39,7 +39,7 @@ public class PersistentRequestRemoved extends BaseMessage { /** * Returns the identifier of the request. - * + * * @return The identifier of the request */ public String getIdentifier() { @@ -48,7 +48,7 @@ public class PersistentRequestRemoved extends BaseMessage { /** * Returns whether the request was removed from the global queue. - * + * * @return true if the request was removed from the global * queue, false if it was removed from the client-local * queue diff --git a/src/net/pterodactylus/fcp/PluginInfo.java b/src/net/pterodactylus/fcp/PluginInfo.java index 28ac341..84ddaea 100644 --- a/src/net/pterodactylus/fcp/PluginInfo.java +++ b/src/net/pterodactylus/fcp/PluginInfo.java @@ -20,14 +20,14 @@ package net.pterodactylus.fcp; /** * The “PluginInfo” message is a reply to the {@link GetPluginInfo} request. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class PluginInfo extends BaseMessage { /** * Creates a new “PluginInfo” message that wraps the received message. - * + * * @param receivedMessage * The received message */ @@ -37,7 +37,7 @@ public class PluginInfo extends BaseMessage { /** * Returns the name of the plugin. - * + * * @return The name of the plugin */ public String getPluginName() { @@ -46,7 +46,7 @@ public class PluginInfo extends BaseMessage { /** * Returns the identifier of the request. - * + * * @return The identifier of the request */ public String getIdentifier() { @@ -55,7 +55,7 @@ public class PluginInfo extends BaseMessage { /** * Returns the original URI of the plugin. - * + * * @return The original URI of the plugin */ public String getOriginalURI() { @@ -64,7 +64,7 @@ public class PluginInfo extends BaseMessage { /** * Returns whether the plugin is started. - * + * * @return true if the plugin is started, false * otherwise */ diff --git a/src/net/pterodactylus/fcp/Priority.java b/src/net/pterodactylus/fcp/Priority.java index 5025c88..45560db 100644 --- a/src/net/pterodactylus/fcp/Priority.java +++ b/src/net/pterodactylus/fcp/Priority.java @@ -20,7 +20,7 @@ package net.pterodactylus.fcp; /** * The priority classes used by the Freenet node. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public enum Priority { diff --git a/src/net/pterodactylus/fcp/ProtocolError.java b/src/net/pterodactylus/fcp/ProtocolError.java index 2a6ada7..f59d1fe 100644 --- a/src/net/pterodactylus/fcp/ProtocolError.java +++ b/src/net/pterodactylus/fcp/ProtocolError.java @@ -20,14 +20,14 @@ package net.pterodactylus.fcp; /** * The “ProtocolError” message signals that something has gone really wrong. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class ProtocolError extends BaseMessage { /** * Creates a new “ProtocolError” message that wraps the received message. - * + * * @param receivedMessage * The received message */ @@ -37,7 +37,7 @@ public class ProtocolError extends BaseMessage { /** * Returns whether the causing message had the “Global” flag set. - * + * * @return true if the causing message had the “Global” flag * set */ @@ -47,7 +47,7 @@ public class ProtocolError extends BaseMessage { /** * Returns the error code. - * + * * @return The error code, or -1 if the error code could not be * parsed */ @@ -57,7 +57,7 @@ public class ProtocolError extends BaseMessage { /** * Returns the description of the error. - * + * * @return The description of the error */ public String getCodeDescription() { @@ -66,7 +66,7 @@ public class ProtocolError extends BaseMessage { /** * Returns some extra description of the error. - * + * * @return Extra description of the error, or null if there is * none */ @@ -76,7 +76,7 @@ public class ProtocolError extends BaseMessage { /** * Returns whether the connection to the node can stay open. - * + * * @return true when the connection has to be closed, * false otherwise */ @@ -86,7 +86,7 @@ public class ProtocolError extends BaseMessage { /** * The identifier of the causing request, if any. - * + * * @return The identifier of the causing request */ public String getIdentifier() { diff --git a/src/net/pterodactylus/fcp/PutFailed.java b/src/net/pterodactylus/fcp/PutFailed.java index a98e02b..b6916f4 100644 --- a/src/net/pterodactylus/fcp/PutFailed.java +++ b/src/net/pterodactylus/fcp/PutFailed.java @@ -27,14 +27,14 @@ import java.util.Map.Entry; * The “PutFailed” message signals the client that a {@link ClientPut} request * has failed. This also means that no further progress messages for that * request will be sent. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class PutFailed extends BaseMessage { /** * Creates a new “PutFailed” message that wraps the received message. - * + * * @param receivedMessage * The received message */ @@ -44,7 +44,7 @@ public class PutFailed extends BaseMessage { /** * Returns the code of the error. - * + * * @return The code of the error, or -1 if the error code could * not be parsed */ @@ -54,7 +54,7 @@ public class PutFailed extends BaseMessage { /** * Returns the identifier of the request. - * + * * @return The identifier of the request */ public String getIdentifier() { @@ -63,7 +63,7 @@ public class PutFailed extends BaseMessage { /** * Returns whether the request is on the global queue. - * + * * @return true if the request is on the global queue, * false if it is on the client-local queue */ @@ -73,7 +73,7 @@ public class PutFailed extends BaseMessage { /** * Returns the description of the error code. - * + * * @return The description of the error code */ public String getCodeDescription() { @@ -82,7 +82,7 @@ public class PutFailed extends BaseMessage { /** * Returns the extra description of the error. - * + * * @return The extra description of the error */ public String getExtraDescription() { @@ -91,7 +91,7 @@ public class PutFailed extends BaseMessage { /** * Returns the short description of the error. - * + * * @return The short description of the error */ public String getShortCodeDescription() { @@ -100,7 +100,7 @@ public class PutFailed extends BaseMessage { /** * Returns the expected URI of the request. - * + * * @return The expected URI */ public String getExpectedURI() { @@ -110,7 +110,7 @@ public class PutFailed extends BaseMessage { /** * Returns whether the request failed fatally. If a request fails fatally it * can never complete, even with inifinite retries. - * + * * @return true if the request failed fatally, * false otherwise */ @@ -122,7 +122,7 @@ public class PutFailed extends BaseMessage { * Returns a list of complex error codes with the message. Use * {@link #getComplexErrorDescription(int)} and * {@link #getComplexErrorCount(int)} to get details. - * + * * @return A list of complex error codes */ public int[] getComplexErrorCodes() { @@ -151,7 +151,7 @@ public class PutFailed extends BaseMessage { /** * Returns the description of the complex error. You should only hand it * error codes you got from {@link #getComplexErrorCodes()}! - * + * * @param errorCode * The error code * @return The description of the complex error @@ -163,7 +163,7 @@ public class PutFailed extends BaseMessage { /** * Returns the count of the complex error. You should only hand it error * codes you got from {@link #getComplexErrorCodes()}! - * + * * @param errorCode * The error code * @return The count of the complex error, or -1 if the count diff --git a/src/net/pterodactylus/fcp/PutFetchable.java b/src/net/pterodactylus/fcp/PutFetchable.java index 7819bfa..0c4e941 100644 --- a/src/net/pterodactylus/fcp/PutFetchable.java +++ b/src/net/pterodactylus/fcp/PutFetchable.java @@ -22,14 +22,14 @@ package net.pterodactylus.fcp; * The “PutFetchable” message informs a client that a {@link ClientPut} request * has progressed far enough that the resulting final URI might already be * fetchable. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class PutFetchable extends BaseMessage { /** * Creates a new “PutFetchable” message that wraps the received message. - * + * * @param receivedMessage * The received message */ @@ -39,7 +39,7 @@ public class PutFetchable extends BaseMessage { /** * Returns the identifier of the request. - * + * * @return The identifier of the request */ public String getIdentifier() { @@ -48,7 +48,7 @@ public class PutFetchable extends BaseMessage { /** * Returns whether the request is on the global queue. - * + * * @return true if the request is on the global queue, * false if it is on the client-local queue */ @@ -58,7 +58,7 @@ public class PutFetchable extends BaseMessage { /** * Returns the URI of the request. - * + * * @return The URI of the request */ public String getURI() { diff --git a/src/net/pterodactylus/fcp/PutSuccessful.java b/src/net/pterodactylus/fcp/PutSuccessful.java index 6352f39..cea36ee 100644 --- a/src/net/pterodactylus/fcp/PutSuccessful.java +++ b/src/net/pterodactylus/fcp/PutSuccessful.java @@ -21,14 +21,14 @@ package net.pterodactylus.fcp; /** * The “PutSuccessful” message informs a client about a successfully finished * {@link ClientPut} (or similar) request. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class PutSuccessful extends BaseMessage { /** * Creates a new “PutSuccessful” message that wraps the received message. - * + * * @param receivedMessage * The received message */ @@ -38,7 +38,7 @@ public class PutSuccessful extends BaseMessage { /** * Returns the identifier of the request. - * + * * @return The identifier of the request */ public String getIdentifier() { @@ -47,7 +47,7 @@ public class PutSuccessful extends BaseMessage { /** * Returns whether the request is on the global queue. - * + * * @return true if the request is on the global queue, * false if it is on the client-local queue */ @@ -57,7 +57,7 @@ public class PutSuccessful extends BaseMessage { /** * Returns the final URI of the {@link ClientPut} request. - * + * * @return The final URI of the request */ public String getURI() { @@ -66,7 +66,7 @@ public class PutSuccessful extends BaseMessage { /** * Returns the time the insert started. - * + * * @return The time the insert started (in milliseconds since Jan 1, 1970 * UTC), or -1 if the time could not be parsed */ @@ -76,7 +76,7 @@ public class PutSuccessful extends BaseMessage { /** * Returns the time the insert completed. - * + * * @return The time the insert completed (in milliseconds since Jan 1, 1970 * UTC), or -1 if the time could not be parsed */ diff --git a/src/net/pterodactylus/fcp/RemovePeer.java b/src/net/pterodactylus/fcp/RemovePeer.java index 10ae44b..5eae728 100644 --- a/src/net/pterodactylus/fcp/RemovePeer.java +++ b/src/net/pterodactylus/fcp/RemovePeer.java @@ -20,14 +20,14 @@ package net.pterodactylus.fcp; /** * The “RemovePeer” command removes a peer. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class RemovePeer extends FcpMessage { /** * Creates a new “RemovePeer” command that removes the given peer. - * + * * @param nodeIdentifier * The identifier of the node, i.e. its name, identity, or IP * address and port pair diff --git a/src/net/pterodactylus/fcp/RemovePersistentRequest.java b/src/net/pterodactylus/fcp/RemovePersistentRequest.java index 859a83d..e5686b9 100644 --- a/src/net/pterodactylus/fcp/RemovePersistentRequest.java +++ b/src/net/pterodactylus/fcp/RemovePersistentRequest.java @@ -22,14 +22,14 @@ package net.pterodactylus.fcp; * The “RemovePersistentRequest” message tells the node to remove a persistent * request, cancelling it first (resulting in a {@link GetFailed} or * {@link PutFailed} message), if necessary. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class RemovePersistentRequest extends FcpMessage { /** * Creates a new “RemovePersistentRequest” message. - * + * * @param identifier * The identifier of the request */ @@ -40,7 +40,7 @@ public class RemovePersistentRequest extends FcpMessage { /** * Sets whether the request is on the global queue. - * + * * @param global * true if the request is on the global queue, * false if it is on the client-local queue diff --git a/src/net/pterodactylus/fcp/ReturnType.java b/src/net/pterodactylus/fcp/ReturnType.java index d7a1b4d..a3ffbcd 100644 --- a/src/net/pterodactylus/fcp/ReturnType.java +++ b/src/net/pterodactylus/fcp/ReturnType.java @@ -20,7 +20,7 @@ package net.pterodactylus.fcp; /** * The different return types for {@link ClientGet} requests. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public enum ReturnType { diff --git a/src/net/pterodactylus/fcp/SSKKeypair.java b/src/net/pterodactylus/fcp/SSKKeypair.java index 11f1a2c..fd0b40a 100644 --- a/src/net/pterodactylus/fcp/SSKKeypair.java +++ b/src/net/pterodactylus/fcp/SSKKeypair.java @@ -21,14 +21,14 @@ package net.pterodactylus.fcp; /** * An “SSKKeypair” message that is sent as a response to a {@link GenerateSSK} * message. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class SSKKeypair extends BaseMessage { /** * Creates a new “SSKKeypair” message that wraps the received message. - * + * * @param receivedMessage * The received message */ @@ -38,7 +38,7 @@ public class SSKKeypair extends BaseMessage { /** * Returns the identifier of the request. - * + * * @return The identifier of the request */ public String getIdentifier() { @@ -47,7 +47,7 @@ public class SSKKeypair extends BaseMessage { /** * Returns the URI that must be used to insert data. - * + * * @return The insert URI */ public String getInsertURI() { @@ -56,7 +56,7 @@ public class SSKKeypair extends BaseMessage { /** * Returns the URI that must be used to request data. - * + * * @return The request URI */ public String getRequestURI() { diff --git a/src/net/pterodactylus/fcp/Shutdown.java b/src/net/pterodactylus/fcp/Shutdown.java index 42b136a..3841c4d 100644 --- a/src/net/pterodactylus/fcp/Shutdown.java +++ b/src/net/pterodactylus/fcp/Shutdown.java @@ -20,7 +20,7 @@ package net.pterodactylus.fcp; /** * Command that shuts down the node. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class Shutdown extends FcpMessage { diff --git a/src/net/pterodactylus/fcp/SimpleProgress.java b/src/net/pterodactylus/fcp/SimpleProgress.java index 7022f56..4d93512 100644 --- a/src/net/pterodactylus/fcp/SimpleProgress.java +++ b/src/net/pterodactylus/fcp/SimpleProgress.java @@ -21,14 +21,14 @@ package net.pterodactylus.fcp; /** * A “SimpleProgress” message tells the client about the progress of a * {@link ClientGet} or {@link ClientPut} operation. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class SimpleProgress extends BaseMessage { /** * Creates a new “SimpleProgress” message that wraps the received message. - * + * * @param receivedMessage * The received message */ @@ -39,7 +39,7 @@ public class SimpleProgress extends BaseMessage { /** * Returns the total number of blocks. This number may increase as long as * {@link #isFinalizedTotal()} returns false. - * + * * @return The total number of blocks */ public int getTotal() { @@ -51,7 +51,7 @@ public class SimpleProgress extends BaseMessage { * This number might actually be lower than {@link #getTotal} because of * redundancy information. This number may also increase as long as * {@link #isFinalizedTotal()} returns false. - * + * * @return The number of required blocks */ public int getRequired() { @@ -60,7 +60,7 @@ public class SimpleProgress extends BaseMessage { /** * Returns the number of blocks that have failed and run out of retries. - * + * * @return The number of failed blocks */ public int getFailed() { @@ -70,7 +70,7 @@ public class SimpleProgress extends BaseMessage { /** * 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() { @@ -79,7 +79,7 @@ public class SimpleProgress extends BaseMessage { /** * Returns the number of blocks that have been successfully processed. - * + * * @return The number of succeeded blocks */ public int getSucceeded() { @@ -91,7 +91,7 @@ public class SimpleProgress extends BaseMessage { * 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 true. - * + * * @return true if the number of total blocks has been * finalized, false otherwise */ @@ -101,7 +101,7 @@ public class SimpleProgress extends BaseMessage { /** * Returns the identifier of the request. - * + * * @return The identifier of the request */ public String getIdentifier() { diff --git a/src/net/pterodactylus/fcp/StartedCompression.java b/src/net/pterodactylus/fcp/StartedCompression.java index 690f815..a7c4fa2 100644 --- a/src/net/pterodactylus/fcp/StartedCompression.java +++ b/src/net/pterodactylus/fcp/StartedCompression.java @@ -21,7 +21,7 @@ package net.pterodactylus.fcp; /** * The “StartedCompression” message signals the client the compressing for a * request has started. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class StartedCompression extends BaseMessage { @@ -29,7 +29,7 @@ public class StartedCompression extends BaseMessage { /** * Creates a new “StartedCompression” message that wraps the received * message. - * + * * @param receivedMessage * The received message */ @@ -39,7 +39,7 @@ public class StartedCompression extends BaseMessage { /** * Returns the identifier of the request. - * + * * @return The identifier of the request */ public String getIdentifier() { @@ -48,7 +48,7 @@ public class StartedCompression extends BaseMessage { /** * Returns the number of the codec that is used for compression. - * + * * @return The codec used for the compression, or -1 if the * codec could not be parsed */ diff --git a/src/net/pterodactylus/fcp/SubscribeUSK.java b/src/net/pterodactylus/fcp/SubscribeUSK.java index ee3dae7..6a18333 100644 --- a/src/net/pterodactylus/fcp/SubscribeUSK.java +++ b/src/net/pterodactylus/fcp/SubscribeUSK.java @@ -21,14 +21,14 @@ package net.pterodactylus.fcp; /** * With a “SubscribeUSK” a client requests to be notified if the edition number * of a USK changes. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class SubscribeUSK extends FcpMessage { /** * Creates a new “SubscribeUSK” message. - * + * * @param uri * The URI to watch for changes * @param identifier @@ -42,7 +42,7 @@ public class SubscribeUSK extends FcpMessage { /** * Sets whether updates for the USK are actively searched. - * + * * @param active * true to actively search for newer editions, * false to only watch for newer editions that are diff --git a/src/net/pterodactylus/fcp/SubscribedUSKUpdate.java b/src/net/pterodactylus/fcp/SubscribedUSKUpdate.java index 764311e..e616b5d 100644 --- a/src/net/pterodactylus/fcp/SubscribedUSKUpdate.java +++ b/src/net/pterodactylus/fcp/SubscribedUSKUpdate.java @@ -24,7 +24,7 @@ package net.pterodactylus.fcp; * if the new edition that was found is several editions ahead of the currently * last known edition, you will received a SubscribedUSKUpdate for each edition * inbetween as welL! - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class SubscribedUSKUpdate extends BaseMessage { @@ -32,7 +32,7 @@ public class SubscribedUSKUpdate extends BaseMessage { /** * Creates a new “SubscribedUSKUpdate” message that wraps the received * message. - * + * * @param receivedMessage * The received message */ @@ -42,7 +42,7 @@ public class SubscribedUSKUpdate extends BaseMessage { /** * Returns the identifier of the subscription. - * + * * @return The identifier of the subscription */ public String getIdentifier() { @@ -51,7 +51,7 @@ public class SubscribedUSKUpdate extends BaseMessage { /** * Returns the new edition that was found. - * + * * @return The new edition */ public int getEdition() { @@ -60,7 +60,7 @@ public class SubscribedUSKUpdate extends BaseMessage { /** * Returns the complete URI, including the new edition. - * + * * @return The complete URI */ public String getURI() { diff --git a/src/net/pterodactylus/fcp/TestDDAComplete.java b/src/net/pterodactylus/fcp/TestDDAComplete.java index 556b631..bea91d9 100644 --- a/src/net/pterodactylus/fcp/TestDDAComplete.java +++ b/src/net/pterodactylus/fcp/TestDDAComplete.java @@ -21,14 +21,14 @@ package net.pterodactylus.fcp; /** * The “TestDDAComplete” message signals that the node has finished checking * your read and write access to a certain directory. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class TestDDAComplete extends BaseMessage { /** * Creates a new “TestDDAComplete” message that wraps the received message. - * + * * @param receivedMessage * The received message */ @@ -38,7 +38,7 @@ public class TestDDAComplete extends BaseMessage { /** * Returns the directory the authorization is given for. - * + * * @return The directory that was tested for read and/or write access */ public String getDirectory() { @@ -47,7 +47,7 @@ public class TestDDAComplete extends BaseMessage { /** * Returns whether read access to the directory is allowed. - * + * * @return true if the client is allowed to read from that * directory, false otherwise */ @@ -57,7 +57,7 @@ public class TestDDAComplete extends BaseMessage { /** * Returns whether write access to the directory is allowed. - * + * * @return true if the client is allowed to write into that * directory, false otherwise */ diff --git a/src/net/pterodactylus/fcp/TestDDAReply.java b/src/net/pterodactylus/fcp/TestDDAReply.java index 77aba45..bf102d6 100644 --- a/src/net/pterodactylus/fcp/TestDDAReply.java +++ b/src/net/pterodactylus/fcp/TestDDAReply.java @@ -24,14 +24,14 @@ package net.pterodactylus.fcp; * {@link #getReadFilename()} will give you a filename. Similarly, if you * specified that you want to write in the directory {@link #getWriteFilename()} * will give you a filename to write {@link #getContentToWrite()} to. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class TestDDAReply extends BaseMessage { /** * Creates a “TestDDAReply” message that wraps the received message. - * + * * @param receivedMessage * The received message */ @@ -41,7 +41,7 @@ public class TestDDAReply extends BaseMessage { /** * Returns the directory the TestDDRequest was made for. - * + * * @return The directory to test */ public String getDirectory() { @@ -51,7 +51,7 @@ public class TestDDAReply extends BaseMessage { /** * Returns the filename you have to read to proof your ability to read that * specific directory. - * + * * @return The name of the file to read */ public String getReadFilename() { @@ -61,7 +61,7 @@ public class TestDDAReply extends BaseMessage { /** * Returns the filename you have to write to to proof your ability to write * to that specific directory. - * + * * @return The name of the file write to */ public String getWriteFilename() { @@ -72,7 +72,7 @@ public class TestDDAReply extends BaseMessage { * If you requested a test for writing permissions you have to write the * return value of this method to the file given by * {@link #getWriteFilename()}. - * + * * @return The content to write to the file */ public String getContentToWrite() { diff --git a/src/net/pterodactylus/fcp/TestDDARequest.java b/src/net/pterodactylus/fcp/TestDDARequest.java index 0836e6c..89a0202 100644 --- a/src/net/pterodactylus/fcp/TestDDARequest.java +++ b/src/net/pterodactylus/fcp/TestDDARequest.java @@ -20,14 +20,14 @@ package net.pterodactylus.fcp; /** * The “TestDDARequest” initiates a DDA test sequence. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class TestDDARequest extends FcpMessage { /** * Creates a new “TestDDARequest” command that initiates a DDA test. - * + * * @param directory * The directory you want to access files in * @param wantReadDirectory diff --git a/src/net/pterodactylus/fcp/TestDDAResponse.java b/src/net/pterodactylus/fcp/TestDDAResponse.java index b82ef66..76660c5 100644 --- a/src/net/pterodactylus/fcp/TestDDAResponse.java +++ b/src/net/pterodactylus/fcp/TestDDAResponse.java @@ -22,7 +22,7 @@ package net.pterodactylus.fcp; * A “TestDDAResponse” is sent to let the node know that either created a file * with the content from {@link TestDDAReply#getContentToWrite()} or that you * read the content of the file given by {@link TestDDAReply#getReadFilename()}. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class TestDDAResponse extends FcpMessage { @@ -31,7 +31,7 @@ public class TestDDAResponse extends FcpMessage { * Creates a new “TestDDAResponse” message that signals that you created the * file given by {@link TestDDAReply#getWriteFilename()} and wrote the * contents given by {@link TestDDAReply#getContentToWrite()} to it. - * + * * @param directory * The directory from the {@link TestDDARequest} command */ @@ -46,7 +46,7 @@ public class TestDDAResponse extends FcpMessage { * specified that you want to write to the directory) and/or that you read * the file given by {@link TestDDAReply#getReadFilename()} (when you * specified you wanted to read the directory). - * + * * @param directory * The directory from the {@link TestDDARequest} command * @param readContent diff --git a/src/net/pterodactylus/fcp/UnknownNodeIdentifier.java b/src/net/pterodactylus/fcp/UnknownNodeIdentifier.java index b0688ba..af7b2f5 100644 --- a/src/net/pterodactylus/fcp/UnknownNodeIdentifier.java +++ b/src/net/pterodactylus/fcp/UnknownNodeIdentifier.java @@ -21,7 +21,7 @@ package net.pterodactylus.fcp; /** * The “UnknownNodeIdentifier” message signals the client that the node * identifier given in a command like {@link ListPeer} is unknown. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class UnknownNodeIdentifier extends BaseMessage { @@ -29,7 +29,7 @@ public class UnknownNodeIdentifier extends BaseMessage { /** * Creates a new “UnknownNodeIdentifier” message that wraps the received * message. - * + * * @param receivedMessage * The received message */ @@ -39,7 +39,7 @@ public class UnknownNodeIdentifier extends BaseMessage { /** * Returns the unknown node identifier. - * + * * @return The unknown node identifier */ public String getNodeIdentifier() { diff --git a/src/net/pterodactylus/fcp/UnknownPeerNoteType.java b/src/net/pterodactylus/fcp/UnknownPeerNoteType.java index e3289e2..b36c4ee 100644 --- a/src/net/pterodactylus/fcp/UnknownPeerNoteType.java +++ b/src/net/pterodactylus/fcp/UnknownPeerNoteType.java @@ -21,7 +21,7 @@ package net.pterodactylus.fcp; /** * The ”UnknownPeerNoteType” message signals the client that the type of peer * note used in a previous {@link ModifyPeerNote} is unknown. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class UnknownPeerNoteType extends BaseMessage { @@ -29,7 +29,7 @@ public class UnknownPeerNoteType extends BaseMessage { /** * Creates a new ”UnknownPeerNoteType” message that wraps the received * message. - * + * * @param receivedMessage * The received message */ @@ -39,7 +39,7 @@ public class UnknownPeerNoteType extends BaseMessage { /** * Returns the type of peer note that is unkown. - * + * * @return The unknown peer note type */ public int getPeerNoteType() { diff --git a/src/net/pterodactylus/fcp/UploadFrom.java b/src/net/pterodactylus/fcp/UploadFrom.java index cc0d168..fff6d19 100644 --- a/src/net/pterodactylus/fcp/UploadFrom.java +++ b/src/net/pterodactylus/fcp/UploadFrom.java @@ -21,7 +21,7 @@ package net.pterodactylus.fcp; /** * Enumeration for the different values for the “UploadFrom” field in * {@link ClientPut} and {@link ClientGet} requests. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public enum UploadFrom { diff --git a/src/net/pterodactylus/fcp/Verbosity.java b/src/net/pterodactylus/fcp/Verbosity.java index 9e58461..62a2da8 100644 --- a/src/net/pterodactylus/fcp/Verbosity.java +++ b/src/net/pterodactylus/fcp/Verbosity.java @@ -24,7 +24,7 @@ package net.pterodactylus.fcp; * that can be composed of several bits. {@link #PROGRESS} and * {@link #COMPRESSION} are single bits in that mask and can be combined into a * new verbosity using {@link #add(Verbosity)}. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class Verbosity { @@ -46,7 +46,7 @@ public class Verbosity { /** * Creates a new verbosity with the given level. - * + * * @param level * The verbosity level */ @@ -57,7 +57,7 @@ public class Verbosity { /** * Adds the given verbosity to this verbosity and returns a verbosity with * the new value. The value of this verbosity is not changed. - * + * * @param verbosity * The verbosity to add to this verbosity * @return The verbosity with the new level. @@ -68,7 +68,7 @@ public class Verbosity { /** * Checks whether this Verbosity contains all bits of the given Verbosity. - * + * * @param verbosity * The verbosity to check for in this Verbosity * @return true if and only if all set bits in the given @@ -88,7 +88,7 @@ public class Verbosity { /** * Parses the given string and creates a Verbosity with the given level. - * + * * @param s * The string to parse * @return The parsed verbosity, or {@link #NONE} if the string could not be diff --git a/src/net/pterodactylus/fcp/Version.java b/src/net/pterodactylus/fcp/Version.java index 72aa120..0f1d5cb 100644 --- a/src/net/pterodactylus/fcp/Version.java +++ b/src/net/pterodactylus/fcp/Version.java @@ -22,7 +22,7 @@ import java.util.StringTokenizer; /** * Container for the “lastGoodVersion” field. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class Version { @@ -43,7 +43,7 @@ public class Version { * Creates a new Version from the given string. The string consists of the * four required fields node name, tree version, protocol version, and build * number, separated by a comma. - * + * * @param version * The version string * @throws NullPointerException @@ -71,7 +71,7 @@ public class Version { /** * Creates a new Version from the given parts. - * + * * @param nodeName * The name of the node implementation * @param treeVersion @@ -90,7 +90,7 @@ public class Version { /** * Returns the name of the node implementation. - * + * * @return The node name */ public String getNodeName() { @@ -99,7 +99,7 @@ public class Version { /** * The tree version of the node. - * + * * @return The tree version of the node */ public String getTreeVersion() { @@ -108,7 +108,7 @@ public class Version { /** * The protocol version of the node - * + * * @return The protocol version of the node */ public String getProtocolVersion() { @@ -117,7 +117,7 @@ public class Version { /** * The build number of the node. - * + * * @return The build number of the node */ public int getBuildNumber() { diff --git a/src/net/pterodactylus/fcp/WatchGlobal.java b/src/net/pterodactylus/fcp/WatchGlobal.java index ffb4681..b973679 100644 --- a/src/net/pterodactylus/fcp/WatchGlobal.java +++ b/src/net/pterodactylus/fcp/WatchGlobal.java @@ -21,14 +21,14 @@ package net.pterodactylus.fcp; /** * The “WatchGlobal” messages enables clients to watch the global queue in * addition to the client-local queue. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class WatchGlobal extends FcpMessage { /** * Enables or disables watching the global queue. - * + * * @param enabled * true to watch the global queue and the * client-local queue, false to watch only the @@ -41,7 +41,7 @@ public class WatchGlobal extends FcpMessage { /** * Enables or disables watching the global queue, optionally masking out * certain events. - * + * * @param enabled * true to watch the global queue and the * client-local queue, false to watch only the