Changeset 8bb114e


Ignore:
Timestamp:
Jan 26, 2017 8:45:58 PM (4 years ago)
Author:
zzz <zzz@…>
Branches:
master
Children:
e461e8f
Parents:
f77fc52
Message:

javadoc fixes part 2 (ticket #1894)

Location:
core/java/src
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • core/java/src/gnu/crypto/prng/IRandomStandalone.java

    rf77fc52 r8bb114e  
    105105    * @param attributes a set of name-value pairs that describe the desired
    106106    * future instance behaviour.
    107     * @exception IllegalArgumentException if at least one of the defined name/
     107    * @throws IllegalArgumentException if at least one of the defined name/
    108108    * value pairs contains invalid data.
    109109    */
     
    114114     *
    115115     * @return the next 8 bits of random data generated from this instance.
    116      * @exception IllegalStateException if the instance is not yet initialised.
    117      * @exception LimLimitReachedExceptionStandalone this instance has reached its
     116     * @throws IllegalStateException if the instance is not yet initialised.
     117     * @throws LimLimitReachedExceptionStandalone this instance has reached its
    118118     * theoretical limit for generating non-repetitive pseudo-random data.
    119119     */
     
    131131     * @param length the maximum number of required random bytes. This method
    132132     * does nothing if this parameter is less than <code>1</code>.
    133      * @exception IllegalStateException if the instance is not yet initialised.
    134      * @exception LimitLimitReachedExceptionStandalonehis instance has reached its
     133     * @throws IllegalStateException if the instance is not yet initialised.
     134     * @throws LimitLimitReachedExceptionStandalonehis instance has reached its
    135135     * theoretical limit for generating non-repetitive pseudo-random data.
    136136     */
     
    173173    * @param offset The offset from whence to begin reading random bytes.
    174174    * @param length The number of random bytes to add.
    175     * @exception IndexOutOfBoundsException If <i>offset</i>, <i>length</i>,
     175    * @throws IndexOutOfBoundsException If <i>offset</i>, <i>length</i>,
    176176    * or <i>offset</i>+<i>length</i> is out of bounds.
    177177    */
  • core/java/src/net/i2p/data/DataHelper.java

    rf77fc52 r8bb114e  
    737737     * @param numBytes 1-8
    738738     * @return non-negative
    739      * @throws AIOOBE
     739     * @throws ArrayIndexOutOfBoundsException
    740740     * @throws IllegalArgumentException if negative (only possible if numBytes = 8)
    741741     */
     
    761761     * @param numBytes 1-8
    762762     * @return non-negative
    763      * @throws AIOOBE
     763     * @throws ArrayIndexOutOfBoundsException
    764764     * @throws IllegalArgumentException if negative (only possible if numBytes = 8)
    765765     * @since 0.8.12
     
    10071007    /**
    10081008     * Helper util to compare two objects, including null handling.
    1009      * <p />
     1009     * <p>
    10101010     *
    10111011     * This treats (null == null) as true, and (null == (!null)) as false.
     
    10221022    /**
    10231023     * Run a deep comparison across the two collections. 
    1024      * <p />
     1024     * <p>
    10251025     *
    10261026     * This treats (null == null) as true, (null == (!null)) as false, and then
    1027      * comparing each element via eq(object, object). <p />
     1027     * comparing each element via eq(object, object). <p>
    10281028     *
    10291029     * If the size of the collections are not equal, the comparison returns false.
     
    10441044
    10451045    /**
    1046      * Run a comparison on the byte arrays, byte by byte.  <p />
     1046     * Run a comparison on the byte arrays, byte by byte.  <p>
    10471047     *
    10481048     * This treats (null == null) as true, (null == (!null)) as false,
  • core/java/src/net/i2p/data/Hash.java

    rf77fc52 r8bb114e  
    4848    /**
    4949     * Pull from cache or return new
    50      * @throws AIOOBE if not enough bytes
     50     * @throws ArrayIndexOutOfBoundsException if not enough bytes
    5151     * @since 0.8.3
    5252     */
  • core/java/src/net/i2p/data/PublicKey.java

    rf77fc52 r8bb114e  
    3030     * Deprecated - used only by deprecated Destination.readBytes(data, off)
    3131     *
    32      * @throws AIOOBE if not enough bytes, FIXME should throw DataFormatException
     32     * @throws ArrayIndexOutOfBoundsException if not enough bytes, FIXME should throw DataFormatException
    3333     * @since 0.8.3
    3434     */
  • core/java/src/net/i2p/data/SDSCache.java

    rf77fc52 r8bb114e  
    156156     *  @return the cached value if available, otherwise
    157157     *          makes a new object and returns it
    158      *  @throws AIOOBE if not enough bytes
    159      *  @throws NPE
     158     *  @throws ArrayIndexOutOfBoundsException if not enough bytes
     159     *  @throws NullPointerException
    160160     */
    161161    public V get(byte[] b, int off) {
  • core/java/src/net/i2p/data/SigningPublicKey.java

    rf77fc52 r8bb114e  
    4141     * Deprecated - used only by deprecated Destination.readBytes(data, off)
    4242     *
    43      * @throws AIOOBE if not enough bytes, FIXME should throw DataFormatException
     43     * @throws ArrayIndexOutOfBoundsException if not enough bytes, FIXME should throw DataFormatException
    4444     * @since 0.8.3
    4545     */
  • core/java/src/net/i2p/util/ZipFileComment.java

    rf77fc52 r8bb114e  
    3838     *          The string is decoded with UTF-8
    3939     *
    40      *  @throws IOE if no valid end-of-central-directory record found
     40     *  @throws IOException if no valid end-of-central-directory record found
    4141     */
    4242    public static String getComment(File file, int max) throws IOException {
     
    5454     *          The string is decoded with UTF-8
    5555     *
    56      *  @throws IOE if no valid end-of-central-directory record found
     56     *  @throws IOException if no valid end-of-central-directory record found
    5757     */
    5858    public static String getComment(File file, int max, int skip) throws IOException {
Note: See TracChangeset for help on using the changeset viewer.