Encodes and decodes to and from Base64 notation.
*Homepage: http://iharder.net/base64.
- *The options parameter, which appears in a few places, is used to pass + *
The options 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
@@ -66,9 +66,9 @@ import java.nio.charset.StandardCharsets;
* when data that's being decoded is gzip-compressed and will decompress it
* automatically. Generally things are cleaner. You'll probably have to
* change some method calls that you were making to support the new
- * options format (ints that you "OR" together).
+ * options format (ints that you "OR" together).
*
decode( String s, boolean gzipCompressed ).
* Added the ability to "suspend" encoding in the Output Stream so
* you can turn on and off the encoding if you need to embed base64
* data in an otherwise "normal" stream (like an XML file).null.
* The object is not GZip-compressed before being encoded.
*
* @param serializableObject The object to encode
@@ -499,7 +499,7 @@ public class Base64 {
* Serializes an object and returns the Base64-encoded
* version of that serialized object. If the object
* cannot be serialized or there is another error,
- * the method will return null.
+ * the method will return null.
* * Valid options:
* GZIP: gzip-compresses object before encoding it.
@@ -931,7 +931,7 @@ public class Base64 {
/**
* Attempts to decode Base64 data and deserialize a Java
- * Object within. Returns null if there was an error.
+ * Object within. Returns null if there was an error.
*
* @param encodedObject The Base64 data to decode
* @return The decoded and deserialized object
@@ -972,7 +972,7 @@ public class Base64 {
*
* @param dataToEncode byte array of data to encode in base64 form
* @param filename Filename for saving encoded data
- * @return true if successful, false otherwise
+ * @return true if successful, false otherwise
* @since 2.1
*/
public static boolean encodeToFile(final byte[] dataToEncode, final String filename) {
@@ -1000,7 +1000,7 @@ public class Base64 {
*
* @param dataToDecode Base64-encoded data as a string
* @param filename Filename for saving decoded data
- * @return true if successful, false otherwise
+ * @return true if successful, false otherwise
* @since 2.1
*/
public static boolean decodeToFile(final String dataToDecode, final String filename) {
@@ -1116,7 +1116,7 @@ public class Base64 {
} // end encodeFromFile
/**
- * Reads infile and encodes it to outfile.
+ * Reads infile and encodes it to outfile.
*
* @param infile Input file
* @param outfile Output file
@@ -1153,7 +1153,7 @@ public class Base64 {
} // end encodeFileToFile
/**
- * Reads infile and decodes it to outfile.
+ * Reads infile and decodes it to outfile.
*
* @param infile Input file
* @param outfile Output file
@@ -1193,7 +1193,7 @@ public class Base64 {
/**
* A {@link Base64.InputStream} will read data from another
- * java.io.InputStream, given in the constructor,
+ * java.io.InputStream, given in the constructor,
* and encode/decode to/from Base64 notation on the fly.
*
* @see Base64
@@ -1224,7 +1224,7 @@ public class Base64 {
/**
* Constructs a {@link Base64.InputStream} in DECODE mode.
*
- * @param in the java.io.InputStream from which to read data.
+ * @param in the java.io.InputStream from which to read data.
* @since 1.3
*/
public InputStream(final java.io.InputStream in) {
@@ -1244,7 +1244,7 @@ public class Base64 {
*
* Example: new Base64.InputStream( in, Base64.DECODE )
*
- * @param in the java.io.InputStream from which to read data.
+ * @param in the java.io.InputStream from which to read data.
* @param options Specified options
* @see Base64#ENCODE
* @see Base64#DECODE
@@ -1404,7 +1404,7 @@ public class Base64 {
/**
* A {@link Base64.OutputStream} will write data to another
- * java.io.OutputStream, given in the constructor,
+ * java.io.OutputStream, given in the constructor,
* and encode/decode to/from Base64 notation on the fly.
*
* @see Base64
@@ -1437,7 +1437,7 @@ public class Base64 {
/**
* Constructs a {@link Base64.OutputStream} in ENCODE mode.
*
- * @param out the java.io.OutputStream to which data will be written.
+ * @param out the java.io.OutputStream to which data will be written.
* @since 1.3
*/
public OutputStream(final java.io.OutputStream out) {
@@ -1457,7 +1457,7 @@ public class Base64 {
*
* Example: new Base64.OutputStream( out, Base64.ENCODE )
*
- * @param out the java.io.OutputStream to which data will be written.
+ * @param out the java.io.OutputStream to which data will be written.
* @param options Specified options.
* @see Base64#ENCODE
* @see Base64#DECODE
diff --git a/artemis-commons/src/main/java/org/apache/activemq/artemis/utils/InetAddresses.java b/artemis-commons/src/main/java/org/apache/activemq/artemis/utils/InetAddresses.java
index 3d4f089d2c..021d805b71 100644
--- a/artemis-commons/src/main/java/org/apache/activemq/artemis/utils/InetAddresses.java
+++ b/artemis-commons/src/main/java/org/apache/activemq/artemis/utils/InetAddresses.java
@@ -44,21 +44,21 @@ import static org.apache.activemq.artemis.utils.ByteUtil.intFromBytes;
*
*
Examples of IP addresses and their byte representations:
*
- * Items MUST be >= 0.
+ * Items MUST be >= 0.
*/
public class ConcurrentLongHashSet {
diff --git a/artemis-commons/src/main/java/org/apache/activemq/artemis/utils/collections/LongHashSet.java b/artemis-commons/src/main/java/org/apache/activemq/artemis/utils/collections/LongHashSet.java
index a86a7f2b1f..201bb93ba9 100644
--- a/artemis-commons/src/main/java/org/apache/activemq/artemis/utils/collections/LongHashSet.java
+++ b/artemis-commons/src/main/java/org/apache/activemq/artemis/utils/collections/LongHashSet.java
@@ -28,7 +28,7 @@ import java.util.NoSuchElementException;
import java.util.Set;
/**
- * A hash set implementation of {@link Set Load data accordingly to the record layouts Basic record layout: The check-size is used to validate if the record is valid and complete Commit/Prepare record layout:
* Differently from an {@code UnrolledLinkedList} this list doesn't optimize addition and removal to achieve a balanced
* utilization among chunks ie a chunk is removed only if empty and chunks can't be merged.
- * This list has been optimized for small-sized chunks (ideally <= 32 elements): this allow search/removal to
+ * This list has been optimized for small-sized chunks (ideally <= 32 elements): this allow search/removal to
* be performed with a greedy approach despite a sparse chunk utilization (ie chunks contains few sparse elements).
*
* From the memory footprint's point of view, this list won't remove the last remaining array although empty to optimize
diff --git a/artemis-commons/src/main/java/org/apache/activemq/artemis/utils/collections/UpdatableIterator.java b/artemis-commons/src/main/java/org/apache/activemq/artemis/utils/collections/UpdatableIterator.java
index d4e15fa50c..204f672697 100644
--- a/artemis-commons/src/main/java/org/apache/activemq/artemis/utils/collections/UpdatableIterator.java
+++ b/artemis-commons/src/main/java/org/apache/activemq/artemis/utils/collections/UpdatableIterator.java
@@ -52,8 +52,6 @@ public class UpdatableIterator
+ * Append to {@code errorMessage} a detailed description of the provided {@link SQLException}.
* The information appended are:
*
*
+ * Append to {@code errorMessage} a detailed description of the provided {@link SQLException}.
* The information appended are:
*
*
+ * It returns a {@link ByteBuffer} with {@link ByteBuffer#capacity()} >= {@code size}.
* The {@code buffer} is zeroed until {@code size} if {@code zeroed=true}, with {@link ByteBuffer#position()}=0 and {@link ByteBuffer#limit()}={@code size}.
*/
ByteBuffer borrow(int size, boolean zeroed);
diff --git a/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/JournalImpl.java b/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/JournalImpl.java
index d5d4a81e6f..af443c4644 100644
--- a/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/JournalImpl.java
+++ b/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/JournalImpl.java
@@ -1846,7 +1846,8 @@ public class JournalImpl extends JournalBase implements TestableJournal, Journal
/**
*
+ *
+ *
* Field Name Size RecordType Byte (1) FileID Integer (4 bytes)
+ *
+ *
Field Name Size RecordType Byte (1) FileID Integer (4 bytes)
* public class SimpleTest {
- * @Rule
+ * @Rule
* public ActiveMQConsumerResource client = new ActiveMQProducerResource( "vm://0", "test.queue" );
*
- * @Test
+ * @Test
* public void testSomething() throws Exception {
* // Use the embedded client here
* ClientMessage message = client.receiveMessage();
diff --git a/artemis-junit/src/main/java/org/apache/activemq/artemis/junit/ActiveMQDynamicProducerResource.java b/artemis-junit/src/main/java/org/apache/activemq/artemis/junit/ActiveMQDynamicProducerResource.java
index 612ab45018..027ada94d0 100644
--- a/artemis-junit/src/main/java/org/apache/activemq/artemis/junit/ActiveMQDynamicProducerResource.java
+++ b/artemis-junit/src/main/java/org/apache/activemq/artemis/junit/ActiveMQDynamicProducerResource.java
@@ -32,10 +32,10 @@ import org.apache.activemq.artemis.api.core.client.ServerLocator;
*
*
* public class SimpleTest {
- * @Rule
+ * @Rule
* public ActiveMQDynamicProducerResource producer = new ActiveMQDynamicProducerResource( "vm://0");
*
- * @Test
+ * @Test
* public void testSomething() throws Exception {
* // Use the embedded ClientProducer here
* producer.sendMessage( "test.address", "String Body" );
diff --git a/artemis-junit/src/main/java/org/apache/activemq/artemis/junit/ActiveMQProducerResource.java b/artemis-junit/src/main/java/org/apache/activemq/artemis/junit/ActiveMQProducerResource.java
index 33ae4d26d3..75d413e57f 100644
--- a/artemis-junit/src/main/java/org/apache/activemq/artemis/junit/ActiveMQProducerResource.java
+++ b/artemis-junit/src/main/java/org/apache/activemq/artemis/junit/ActiveMQProducerResource.java
@@ -33,10 +33,10 @@ import org.apache.activemq.artemis.api.core.client.ServerLocator;
*
*
* public class SimpleTest {
- * @Rule
+ * @Rule
* public ActiveMQProducerResource producer = new ActiveMQProducerResource( "vm://0", "test.queue");
*
- * @Test
+ * @Test
* public void testSomething() throws Exception {
* // Use the embedded ClientProducer here
* producer.sendMessage( "String Body" );
diff --git a/artemis-junit/src/main/java/org/apache/activemq/artemis/junit/EmbeddedActiveMQResource.java b/artemis-junit/src/main/java/org/apache/activemq/artemis/junit/EmbeddedActiveMQResource.java
index 6ae3c6ab9c..6c038f295c 100644
--- a/artemis-junit/src/main/java/org/apache/activemq/artemis/junit/EmbeddedActiveMQResource.java
+++ b/artemis-junit/src/main/java/org/apache/activemq/artemis/junit/EmbeddedActiveMQResource.java
@@ -55,10 +55,10 @@ import org.slf4j.LoggerFactory;
*
*
* public class SimpleTest {
- * @Rule
+ * @Rule
* public EmbeddedActiveMQResource server = new EmbeddedActiveMQResource();
*
- * @Test
+ * @Test
* public void testSomething() throws Exception {
* // Use the embedded server here
* }
diff --git a/artemis-junit/src/main/java/org/apache/activemq/artemis/junit/EmbeddedJMSResource.java b/artemis-junit/src/main/java/org/apache/activemq/artemis/junit/EmbeddedJMSResource.java
index be21a6f60d..acd98b87f4 100644
--- a/artemis-junit/src/main/java/org/apache/activemq/artemis/junit/EmbeddedJMSResource.java
+++ b/artemis-junit/src/main/java/org/apache/activemq/artemis/junit/EmbeddedJMSResource.java
@@ -66,10 +66,10 @@ import org.slf4j.LoggerFactory;
*
*
* public class SimpleTest {
- * @Rule
+ * @Rule
* public EmbeddedJMSResource server = new EmbeddedJMSResource();
*
- * @Test
+ * @Test
* public void testSomething() throws Exception {
* // Use the embedded server here
* }
diff --git a/artemis-protocols/artemis-amqp-protocol/src/main/java/org/apache/activemq/artemis/protocol/amqp/converter/AMQPMessageIdHelper.java b/artemis-protocols/artemis-amqp-protocol/src/main/java/org/apache/activemq/artemis/protocol/amqp/converter/AMQPMessageIdHelper.java
index e53d2cc5d6..baf08aeefb 100644
--- a/artemis-protocols/artemis-amqp-protocol/src/main/java/org/apache/activemq/artemis/protocol/amqp/converter/AMQPMessageIdHelper.java
+++ b/artemis-protocols/artemis-amqp-protocol/src/main/java/org/apache/activemq/artemis/protocol/amqp/converter/AMQPMessageIdHelper.java
@@ -208,7 +208,7 @@ public class AMQPMessageIdHelper {
* the object to be converted
* @return the AMQP messageId style object
*
- * @throws IllegalArgument
+ * @throws ActiveMQAMQPIllegalStateException
* if the provided baseId String indicates an encoded type but can't
* be converted to that type.
*/
diff --git a/artemis-protocols/artemis-mqtt-protocol/src/main/java/org/apache/activemq/artemis/core/protocol/mqtt/MQTTConnection.java b/artemis-protocols/artemis-mqtt-protocol/src/main/java/org/apache/activemq/artemis/core/protocol/mqtt/MQTTConnection.java
index 9f7d6f4951..fbc6d8aaa3 100644
--- a/artemis-protocols/artemis-mqtt-protocol/src/main/java/org/apache/activemq/artemis/core/protocol/mqtt/MQTTConnection.java
+++ b/artemis-protocols/artemis-mqtt-protocol/src/main/java/org/apache/activemq/artemis/core/protocol/mqtt/MQTTConnection.java
@@ -288,7 +288,6 @@ public class MQTTConnection implements RemotingConnection {
* Sets the client ID associated with this connection
*
* @param cID
- * @return
*/
@Override
public void setClientID(String cID) {
diff --git a/artemis-server/pom.xml b/artemis-server/pom.xml
index f5436f39b1..d472cd0af8 100644
--- a/artemis-server/pom.xml
+++ b/artemis-server/pom.xml
@@ -222,7 +222,6 @@
*
/etc/hosts
* entry exists for a given host, the following exception will be thrown:
*
* java.net.UnknownHostException: <hostname>: <hostname>
@@ -241,7 +241,7 @@ public class IdGenerator {
* Instead of just throwing an UnknownHostException and giving up, this
* method grabs a suitable hostname from the exception and prevents the
* exception from being thrown. If a suitable hostname cannot be acquired
- * from the exception, only then is the UnknownHostException thrown.
+ * from the exception, only then is the UnknownHostException thrown.
*
* @return The hostname
* @throws UnknownHostException if the given host cannot be looked up.