forked from I2P_Developers/i2p.i2p
javadoc fixes part 3 (ticket #1894)
This commit is contained in:
@@ -48,7 +48,7 @@ public class BitField
|
||||
* as set by the given byte array. This will make a copy of the array.
|
||||
* Extra bytes will be ignored.
|
||||
*
|
||||
* @exception ArrayOutOfBoundsException if give byte array is not large
|
||||
* @throws ArrayOutOfBoundsException if give byte array is not large
|
||||
* enough.
|
||||
*/
|
||||
public BitField(byte[] bitfield, int size)
|
||||
@@ -90,7 +90,7 @@ public class BitField
|
||||
/**
|
||||
* Sets the given bit to true.
|
||||
*
|
||||
* @exception IndexOutOfBoundsException if bit is smaller then zero
|
||||
* @throws IndexOutOfBoundsException if bit is smaller then zero
|
||||
* bigger then size (inclusive).
|
||||
*/
|
||||
public void set(int bit)
|
||||
@@ -110,7 +110,7 @@ public class BitField
|
||||
/**
|
||||
* Sets the given bit to false.
|
||||
*
|
||||
* @exception IndexOutOfBoundsException if bit is smaller then zero
|
||||
* @throws IndexOutOfBoundsException if bit is smaller then zero
|
||||
* bigger then size (inclusive).
|
||||
* @since 0.9.22
|
||||
*/
|
||||
@@ -141,7 +141,7 @@ public class BitField
|
||||
/**
|
||||
* Return true if the bit is set or false if it is not.
|
||||
*
|
||||
* @exception IndexOutOfBoundsException if bit is smaller then zero
|
||||
* @throws IndexOutOfBoundsException if bit is smaller then zero
|
||||
* bigger then size (inclusive).
|
||||
*/
|
||||
public boolean get(int bit)
|
||||
|
||||
@@ -464,7 +464,7 @@ public class MetaInfo
|
||||
* Return the length of a piece. All pieces are of equal length
|
||||
* except for the last one (<code>getPieces()-1</code>).
|
||||
*
|
||||
* @exception IndexOutOfBoundsException when piece is equal to or
|
||||
* @throws IndexOutOfBoundsException when piece is equal to or
|
||||
* greater then the number of pieces in the torrent.
|
||||
*/
|
||||
public int getPieceLength(int piece)
|
||||
|
||||
@@ -115,7 +115,7 @@ public class Peer implements Comparable<Peer>
|
||||
* the connect() method.
|
||||
*
|
||||
* @param metainfo null if in magnet mode
|
||||
* @exception IOException when an error occurred during the handshake.
|
||||
* @throws IOException when an error occurred during the handshake.
|
||||
*/
|
||||
public Peer(final I2PSocket sock, InputStream in, OutputStream out, byte[] my_id, byte[] infohash, MetaInfo metainfo)
|
||||
throws IOException
|
||||
|
||||
@@ -1111,7 +1111,7 @@ public class Storage implements Closeable
|
||||
*
|
||||
* @return true if the piece was correct (sha metainfo hash
|
||||
* matches), otherwise false.
|
||||
* @exception IOException when some storage related error occurs.
|
||||
* @throws IOException when some storage related error occurs.
|
||||
*/
|
||||
public boolean putPiece(PartialPiece pp) throws IOException
|
||||
{
|
||||
|
||||
@@ -102,9 +102,9 @@ public class BDecoder
|
||||
* @return The first BEValue on the stream or null when the stream
|
||||
* has ended.
|
||||
*
|
||||
* @exception InvalidBEncoding when the stream doesn't start with a
|
||||
* @throws InvalidBEncoding when the stream doesn't start with a
|
||||
* bencoded value or the stream isn't a bencoded stream at all.
|
||||
* @exception IOException when somthing bad happens with the stream
|
||||
* @throws IOException when somthing bad happens with the stream
|
||||
* to read from.
|
||||
*/
|
||||
public static BEValue bdecode(InputStream in) throws IOException
|
||||
|
||||
@@ -71,7 +71,7 @@ public class MultiPartRequest
|
||||
/** Constructor.
|
||||
* @param request The request containing a multipart/form-data
|
||||
* request
|
||||
* @exception IOException IOException
|
||||
* @throws IOException IOException
|
||||
*/
|
||||
public MultiPartRequest(HttpServletRequest request)
|
||||
throws IOException
|
||||
|
||||
@@ -113,7 +113,7 @@ public class LineInput extends FilterInputStream
|
||||
* @param in The underlying input stream.
|
||||
* @param bufferSize The buffer size and maximum line length.
|
||||
* @param encoding the character encoding to use for readLine methods.
|
||||
* @exception UnsupportedEncodingException
|
||||
* @throws UnsupportedEncodingException
|
||||
*/
|
||||
public LineInput(InputStream in, int bufferSize, String encoding)
|
||||
throws UnsupportedEncodingException
|
||||
@@ -180,7 +180,7 @@ public class LineInput extends FilterInputStream
|
||||
* The default or supplied encoding is used to convert bytes to
|
||||
* characters.
|
||||
* @return The line as a String or null for EOF.
|
||||
* @exception IOException
|
||||
* @throws IOException
|
||||
*/
|
||||
public synchronized String readLine()
|
||||
throws IOException
|
||||
@@ -217,7 +217,7 @@ public class LineInput extends FilterInputStream
|
||||
* @param off Offset into the buffer.
|
||||
* @param len Maximum length of line.
|
||||
* @return The length of the line or -1 for EOF.
|
||||
* @exception IOException
|
||||
* @throws IOException
|
||||
*/
|
||||
public int readLine(char[] c,int off,int len)
|
||||
throws IOException
|
||||
@@ -251,7 +251,7 @@ public class LineInput extends FilterInputStream
|
||||
* @param off Offset into the buffer.
|
||||
* @param len Maximum length of line.
|
||||
* @return The length of the line or -1 for EOF.
|
||||
* @exception IOException
|
||||
* @throws IOException
|
||||
*/
|
||||
public int readLine(byte[] b,int off,int len)
|
||||
throws IOException
|
||||
@@ -277,7 +277,7 @@ public class LineInput extends FilterInputStream
|
||||
* The default or supplied encoding is used to convert bytes to
|
||||
* characters.
|
||||
* @return LineBuffer instance or null for EOF.
|
||||
* @exception IOException
|
||||
* @throws IOException
|
||||
*/
|
||||
public LineBuffer readLineBuffer()
|
||||
throws IOException
|
||||
@@ -293,7 +293,7 @@ public class LineInput extends FilterInputStream
|
||||
* characters.
|
||||
* @param len Maximum length of a line, or 0 for default
|
||||
* @return LineBuffer instance or null for EOF.
|
||||
* @exception IOException
|
||||
* @throws IOException
|
||||
*/
|
||||
public LineBuffer readLineBuffer(int len)
|
||||
throws IOException
|
||||
|
||||
@@ -117,7 +117,7 @@ private ResourceBundle _messages = ResourceBundle.getBundle(
|
||||
* @param flag If non-null, this is a location to store the value of "val" when this option is encountered, otherwise "val" is treated as the equivalent short option character.
|
||||
* @param val The value to return for this long option, or the equivalent single letter option to emulate if flag is null.
|
||||
*
|
||||
* @exception IllegalArgumentException If the has_arg param is not one of NO_ARGUMENT, REQUIRED_ARGUMENT or OPTIONAL_ARGUMENT.
|
||||
* @throws IllegalArgumentException If the has_arg param is not one of NO_ARGUMENT, REQUIRED_ARGUMENT or OPTIONAL_ARGUMENT.
|
||||
*/
|
||||
public
|
||||
LongOpt(String name, int has_arg,
|
||||
|
||||
@@ -371,7 +371,7 @@ public final class CryptixRijndael_Algorithm // implicit no-argument constructor
|
||||
* session key, assuming Rijndael's default block size (128-bit).
|
||||
*
|
||||
* @param k The 128/192/256-bit user-key to use.
|
||||
* @exception InvalidKeyException If the key is invalid.
|
||||
* @throws InvalidKeyException If the key is invalid.
|
||||
*/
|
||||
public static final Object makeKey(byte[] k) throws InvalidKeyException {
|
||||
return makeKey(k, _BLOCK_SIZE);
|
||||
@@ -550,7 +550,7 @@ public final class CryptixRijndael_Algorithm // implicit no-argument constructor
|
||||
*
|
||||
* @param k The 128/192/256-bit user-key to use.
|
||||
* @param blockSize The block size in bytes of this Rijndael.
|
||||
* @exception InvalidKeyException If the key is invalid.
|
||||
* @throws InvalidKeyException If the key is invalid.
|
||||
*/
|
||||
public static final/* synchronized */Object makeKey(byte[] k, int blockSize) throws InvalidKeyException {
|
||||
return makeKey(k, blockSize, null);
|
||||
|
||||
@@ -38,7 +38,7 @@ public interface Mac
|
||||
* Initialise the MAC.
|
||||
*
|
||||
* @param key the key required by the MAC.
|
||||
* @exception IllegalArgumentException if the params argument is
|
||||
* @throws IllegalArgumentException if the params argument is
|
||||
* inappropriate.
|
||||
*/
|
||||
public void init(byte key[])
|
||||
@@ -62,7 +62,7 @@ public interface Mac
|
||||
* add a single byte to the mac for processing.
|
||||
*
|
||||
* @param in the byte to be processed.
|
||||
* @exception IllegalStateException if the MAC is not initialised.
|
||||
* @throws IllegalStateException if the MAC is not initialised.
|
||||
*/
|
||||
public void update(byte in)
|
||||
throws IllegalStateException;
|
||||
@@ -71,7 +71,7 @@ public interface Mac
|
||||
* @param in the array containing the input.
|
||||
* @param inOff the index in the array the data begins at.
|
||||
* @param len the length of the input starting at inOff.
|
||||
* @exception IllegalStateException if the MAC is not initialised.
|
||||
* @throws IllegalStateException if the MAC is not initialised.
|
||||
*/
|
||||
public void update(byte[] in, int inOff, int len)
|
||||
throws IllegalStateException;
|
||||
@@ -84,7 +84,7 @@ public interface Mac
|
||||
*
|
||||
* @param out the array the MAC is to be output to.
|
||||
* @param outOff the offset into the out buffer the output is to start at.
|
||||
* @exception IllegalStateException if the MAC is not initialised.
|
||||
* @throws IllegalStateException if the MAC is not initialised.
|
||||
*/
|
||||
public int doFinal(byte[] out, int outOff)
|
||||
throws IllegalStateException;
|
||||
|
||||
Reference in New Issue
Block a user