Skip to content

Commit

Permalink
Merge pull request hornetq#1545 from scop/javadoc8
Browse files Browse the repository at this point in the history
Javadoc 1.8 error fixes
  • Loading branch information
clebertsuconic committed Feb 24, 2014
2 parents a990d50 + 9d16492 commit 0839366
Show file tree
Hide file tree
Showing 76 changed files with 216 additions and 240 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
/**
* A simple String class that can store all characters, and stores as simple {@code byte[]}, this
* minimises expensive copying between String objects.
* <p/>
* <p>
* This object is used heavily throughout HornetQ for performance reasons.
*
* @author <a href="mailto:[email protected]">Tim Fox</a>
Expand All @@ -45,7 +45,7 @@ public final class SimpleString implements CharSequence, Serializable, Comparabl

/**
* Returns a SimpleString constructed from the {@code string} parameter.
* <p/>
* <p>
* If {@code string} is {@code null}, the return value will be {@code null} too.
*
* @param string String used to instantiate a SimpleString.
Expand Down
38 changes: 16 additions & 22 deletions hornetq-commons/src/main/java/org/hornetq/utils/Base64.java
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,18 @@
/**
* <p>Encodes and decodes to and from Base64 notation.</p>
* <p>Homepage: <a href="http://iharder.net/base64">http://iharder.net/base64</a>.</p>
* <p/>
* <p>The <tt>options</tt> parameter, which appears in a few places, is used to pass
* several pieces of information to the encoder. In the "higher level" methods such as
* encodeBytes( bytes, options ) the options parameter can be used to indicate such
* things as first gzipping the bytes before encoding them, not inserting linefeeds
* (though that breaks strict Base64 compatibility), and encoding using the URL-safe
* and Ordered dialects.</p>
* <p/>
* <p>The constants defined in Base64 can be OR-ed together to combine options, so you
* might make a call like this:</p>
* <p/>
* <p>
* <code>String encoded = Base64.encodeBytes( mybytes, Base64.GZIP | Base64.DONT_BREAK_LINES );</code>
* <p/>
* </p>
* <p>to compress the data before encoding it and then making the output have no newline characters.</p>
* <p/>
* <p/>
* <p>
* Change Log:
* </p>
Expand All @@ -42,7 +38,7 @@
* Base64.InputStream class to encode and decode on the fly which uses
* less memory than encoding/decoding an entire file into memory before writing.</li>
* <li>v2.2.1 - Fixed bug using URL_SAFE and ORDERED encodings. Fixed bug
* when using very small files (~< 40 bytes).</li>
* when using very small files (~&lt; 40 bytes).</li>
* <li>v2.2 - Added some helper methods for encoding/decoding directly from
* one file to the next. Also added a main() method to support command line
* encoding/decoding from one file to the next. Also added these Base64 dialects:
Expand All @@ -58,7 +54,6 @@
* Special thanks to Jim Kellerman at <a href="http://www.powerset.com/">http://www.powerset.com/</a>
* for contributing the new Base64 dialects.
* </li>
* <p/>
* <li>v2.1 - Cleaned up javadoc comments and unused variables and methods. Added
* some convenience methods for reading and writing to and from files.</li>
* <li>v2.0.2 - Now specifies UTF-8 encoding in places where the code fails on systems
Expand Down Expand Up @@ -86,7 +81,6 @@
* <li>v1.3.4 - Fixed when "improperly padded stream" error was thrown at the wrong time.</li>
* <li>v1.3.3 - Fixed I/O streams which were totally messed up.</li>
* </ul>
* <p/>
* <p>
* I am placing this code in the Public Domain. Do with it as you will.
* This software comes with no guarantees or warranties but with
Expand Down Expand Up @@ -1038,15 +1032,15 @@ public static String encodeObject(final java.io.Serializable serializableObject)
* version of that serialized object. If the object
* cannot be serialized or there is another error,
* the method will return <tt>null</tt>.
* <p/>
* <p>
* Valid options:<pre>
* GZIP: gzip-compresses object before encoding it.
* DONT_BREAK_LINES: don't break lines at 76 characters
* <i>Note: Technically, this makes your encoding non-compliant.</i>
* </pre>
* <p/>
* <p>
* Example: <code>encodeObject( myObj, Base64.GZIP )</code> or
* <p/>
* <p>
* Example: <code>encodeObject( myObj, Base64.GZIP | Base64.DONT_BREAK_LINES )</code>
*
* @param serializableObject The object to encode
Expand Down Expand Up @@ -1142,15 +1136,15 @@ public static String encodeBytes(final byte[] source)

/**
* Encodes a byte array into Base64 notation.
* <p/>
* <p>
* Valid options:<pre>
* GZIP: gzip-compresses object before encoding it.
* DONT_BREAK_LINES: don't break lines at 76 characters
* <i>Note: Technically, this makes your encoding non-compliant.</i>
* </pre>
* <p/>
* <p>
* Example: <code>encodeBytes( myData, Base64.GZIP )</code> or
* <p/>
* <p>
* Example: <code>encodeBytes( myData, Base64.GZIP | Base64.DONT_BREAK_LINES )</code>
*
* @param source The data to convert
Expand Down Expand Up @@ -1180,15 +1174,15 @@ public static String encodeBytes(final byte[] source, final int off, final int l

/**
* Encodes a byte array into Base64 notation.
* <p/>
* <p>
* Valid options:<pre>
* GZIP: gzip-compresses object before encoding it.
* DONT_BREAK_LINES: don't break lines at 76 characters
* <i>Note: Technically, this makes your encoding non-compliant.</i>
* </pre>
* <p/>
* <p>
* Example: <code>encodeBytes( myData, Base64.GZIP )</code> or
* <p/>
* <p>
* Example: <code>encodeBytes( myData, Base64.GZIP | Base64.DONT_BREAK_LINES )</code>
*
* @param source The data to convert
Expand Down Expand Up @@ -1935,14 +1929,14 @@ public InputStream(final java.io.InputStream in)
/**
* Constructs a {@link Base64.InputStream} in
* either ENCODE or DECODE mode.
* <p/>
* <p>
* Valid options:<pre>
* ENCODE or DECODE: Encode or Decode as data is read.
* DONT_BREAK_LINES: don't break lines at 76 characters
* (only meaningful when encoding)
* <i>Note: Technically, this makes your encoding non-compliant.</i>
* </pre>
* <p/>
* <p>
* Example: <code>new Base64.InputStream( in, Base64.DECODE )</code>
*
* @param in the <tt>java.io.InputStream</tt> from which to read data.
Expand Down Expand Up @@ -2189,14 +2183,14 @@ public OutputStream(final java.io.OutputStream out)
/**
* Constructs a {@link Base64.OutputStream} in
* either ENCODE or DECODE mode.
* <p/>
* <p>
* Valid options:<pre>
* ENCODE or DECODE: Encode or Decode as data is read.
* DONT_BREAK_LINES: don't break lines at 76 characters
* (only meaningful when encoding)
* <i>Note: Technically, this makes your encoding non-compliant.</i>
* </pre>
* <p/>
* <p>
* Example: <code>new Base64.OutputStream( out, Base64.ENCODE )</code>
*
* @param out the <tt>java.io.OutputStream</tt> to which data will be written.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
/**
* This class will be used to perform generic class-loader operations,
* such as load a class first using TCCL, and then the classLoader used by HornetQ (ClassloadingUtil.getClass().getClassLoader()).
* <p/>
* <p>
* Is't required to use a Security Block on any calls to this class.
*
* @author <a href="mailto:[email protected]">Howard Gao</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
/**
* A PasswordMarkingUtil
*
* @author <mailto:[email protected]">Howard Gao</a>
* @author <a href="mailto:[email protected]">Howard Gao</a>
*
*
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@

/**
* Property Value Conversion.
* <p/>
* This implementation follows section 3.5.4 of the <i>Java Message Service<i> specification
* <p>
* This implementation follows section 3.5.4 of the <i>Java Message Service</i> specification
* (Version 1.1 April 12, 2002).
* <p/>
* <p>
* TODO - should have typed property getters and do conversions herein
*
* @author <a href="mailto:[email protected]">Tim Fox</a>
Expand Down
6 changes: 3 additions & 3 deletions hornetq-commons/src/main/java/org/hornetq/utils/UUID.java
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,17 @@
* world). UUIDs are usually generated via UUIDGenerator (or in case of 'Null
* UUID', 16 zero bytes, via static method getNullUUID()), or received from
* external systems.
* <p/>
* <p>
* By default class caches the string presentations of UUIDs so that description
* is only created the first time it's needed. For memory stingy applications
* this caching can be turned off (note though that if uuid.toString() is never
* called, desc is never calculated so only loss is the space allocated for the
* desc pointer... which can of course be commented out to save memory).
* <p/>
* <p>
* Similarly, hash code is calculated when it's needed for the first time, and
* from thereon that value is just returned. This means that using UUIDs as keys
* should be reasonably efficient.
* <p/>
* <p>
* UUIDs can be compared for equality, serialized, cloned and even sorted.
* Equality is a simple bit-wise comparison. Ordering (for sorting) is done by
* first ordering based on type (in the order of numeric values of types),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
* system, file-based locking is used. This works between multiple JVMs and Jug
* instances.
* </ul>
* <p/>
* <p>
* Some additional assumptions about calculating the timestamp:
* <ul>
* <li>System.currentTimeMillis() is assumed to give time offset in UTC, or at
Expand All @@ -59,7 +59,7 @@
* of Gregorian calendar is assumed to be correct (which seems to be the case
* when testing with Java calendars).
* </ul>
* <p/>
* <p>
* Note about synchronization: this class is assumed to always be called from a
* synchronized context (caller locks on either this object, or a similar timer
* lock), and so has no method synchronization.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,16 @@

/**
* BroadcastEndpint is used in BroadcastGroups and DiscoveryGroups for topology updates.
* <p/>
* <p>
* A BroadcastEndpoint can perform one of the two following tasks:
* <ul>
* <li>when being used in BroadcastGroups, it broadcasts connector informations</li>
* <li>when being used in DiscoveryGroups, it receives broadcasts</li>
* <p/>
* </ul>
* <p>
* The two tasks are mutual exclusive, meaning a BroadcastEndpoint can either be a broadcaster
* or a receiver, but not both.
* <p/>
* <p>
* It is an abstraction of various concrete broadcasting mechanisms. Different implementations
* of this interface may use different broadcasting techniques like UDP multicasting or
* JGroups channels.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@
/**
* This file represents how we are using Discovery.
* <p>
* The discovery configuration could either use plain UDP, or JGroups.<br/>
* The discovery configuration could either use plain UDP, or JGroups.<br>
* If using UDP, all the UDP properties will be filled and the jgroups properties will be
* {@code null}.<br/>
* {@code null}.<br>
* If using JGroups, all the UDP properties will be -1 or {@code null} and the jgroups properties
* will be filled.<br/>
* will be filled.<br>
* If by any reason, both properties are filled, the JGroups takes precedence. That means, if
* {@code jgroupsFile != null} then the Grouping method used will be JGroups.
* @author <a href="mailto:[email protected]">Tim Fox</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
* UDP attributes in order to form a version 2.2 DiscoveryGroupConfiguration
* in time of serialization.
*
* @see org.hornetq.api.core.DiscoveryGroupConfiguration.readObject(ObjectInputStream)
* @see org.hornetq.api.core.DiscoveryGroupConfiguration.writeObject(ObjectOutputStream)
* @see DiscoveryGroupConfiguration#readObject(java.io.ObjectInputStream)
* @see DiscoveryGroupConfiguration#writeObject(java.io.ObjectOutputStream)
*
* @author <a href="mailto:[email protected]">Andy Taylor</a>
* 12/13/12
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@

/**
* This is class is a simple way to intercepting calls on HornetQ client and servers.
* <p/>
* <p>
* To add an interceptor to HornetQ server, you have to modify the server configuration file
* {@literal hornetq-configuration.xml}. <br/>
* {@literal hornetq-configuration.xml}.<br>
* To add it to a client, use {@link ServerLocator#addIncomingInterceptor(Interceptor)}
*
* @author [email protected]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@
* The configuration for creating broadcasting/discovery groups using JGroups channels
* There are two ways to constructing a JGroups channel (JChannel):
* <ol>
* <li> by passing in a JGroups configuration file</li>
* <li> by passing in a JGroups configuration file<br>
* The file must exists in the hornetq classpath. HornetQ creates a JChannel with the
* configuration file and use it for broadcasting and discovery. In standalone server
* mode HornetQ uses this way for constructing JChannels.
* <li> by passing in a JChannel instance </li>
* mode HornetQ uses this way for constructing JChannels.</li>
* <li> by passing in a JChannel instance<br>
* This is useful when HornetQ needs to get a JChannel from a running JGroups service as in the
* case of AS7 integration.
* case of AS7 integration.</li>
* </ol>
* <p/>
* <p>
* Note only one JChannel is needed in a VM. To avoid the channel being prematurely disconnected
* by any party, a wrapper class is used.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,14 @@

/**
* A Message is a routable instance that has a payload.
* <p/>
* <p>
* The payload (the "body") is opaque to the messaging system. A Message also has a fixed set of
* headers (required by the messaging system) and properties (defined by the users) that can be used
* by the messaging system to route the message (e.g. to ensure it matches a queue filter).
* <p/>
* <h2>Message Properties</h2>
* <p/>
* <p>
* Message can contain properties specified by the users. It is possible to convert from some types
* to other types as specified by the following table:
* <p/>
* <pre>
* | | boolean byte short int long float double String byte[]
* |----------------------------------------------------------------
Expand All @@ -44,8 +42,7 @@
* |byte[] | X
* |-----------------------------------------------------------------
* </pre>
* <p/>
* <br>
* <p>
* If conversion is not allowed (for example calling {@code getFloatProperty} on a property set a
* {@code boolean}), a {@link PropertyConversionException} will be thrown.
*
Expand Down Expand Up @@ -123,7 +120,7 @@ public interface Message

/**
* Returns this message type.
* <p/>
* <p>
* See fields {@literal *_TYPE} for possible values.
*/
byte getType();
Expand Down Expand Up @@ -174,14 +171,14 @@ public interface Message

/**
* Returns the message priority.
* <p/>
* <p>
* Values range from 0 (less priority) to 9 (more priority) inclusive.
*/
byte getPriority();

/**
* Sets the message priority.
* <p/>
* <p>
* Value must be between 0 and 9 inclusive.
*
* @param priority the new message priority
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
* Typically the constructors take the class name and parameters for needed to create the
* connection. These will be different dependent on which connector is being used, i.e. Netty or
* InVM etc. For example:
* <p/>
*
* <pre>
* HashMap&lt;String, Object&gt; map = new HashMap&lt;String, Object&gt;();
Expand Down Expand Up @@ -281,7 +280,7 @@ public String toString()

/**
* Encodes this TransportConfiguration into a buffer.
* <p/>
* <p>
* Note that this is only used internally HornetQ.
*
* @param buffer the buffer to encode into
Expand Down Expand Up @@ -331,7 +330,7 @@ else if (val instanceof String)

/**
* Decodes this TransportConfiguration from a buffer.
* <p/>
* <p>
* Note this is only used internally by HornetQ
*
* @param buffer the buffer to decode from
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

/**
* The configuration used to determine how the server will broadcast members.
* <p/>
* <p>
* This is analogous to {@link org.hornetq.api.core.DiscoveryGroupConfiguration}
*
* @author <a href="mailto:[email protected]">Tim Fox</a> Created 18 Nov 2008 08:44:30
Expand Down
Loading

0 comments on commit 0839366

Please sign in to comment.