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
* 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
*
* @param queueConfiguration the configuration to use when creating the queue
- * @return the {@code Queue} instance that was created
- * @throws Exception
+ * @throws ActiveMQException
*/
void createQueue(QueueConfiguration queueConfiguration) throws ActiveMQException;
diff --git a/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/ActiveMQServerControl.java b/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/ActiveMQServerControl.java
index b4e6c3aca6..643fb53fad 100644
--- a/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/ActiveMQServerControl.java
+++ b/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/ActiveMQServerControl.java
@@ -1763,7 +1763,7 @@ public interface ActiveMQServerControl {
* List the information about a user or all users if no username is supplied (only applicable when using the JAAS PropertiesLoginModule).
*
* @param username
- * @return JSON array of user & role information
+ * @return JSON array of user and role information
* @throws Exception
*/
@Operation(desc = "list info about a user or all users if no username is supplied (only applicable when using the JAAS PropertiesLoginModule)", impact = MBeanOperationInfo.ACTION)
diff --git a/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/AddressControl.java b/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/AddressControl.java
index 908fb20c9c..23817ed02e 100644
--- a/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/AddressControl.java
+++ b/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/AddressControl.java
@@ -84,7 +84,7 @@ public interface AddressControl {
String[] getQueueNames() throws Exception;
/**
- * Returns the names of both the local & remote queue(s) bound to this address.
+ * Returns the names of both the local and remote queue(s) bound to this address.
*/
@Attribute(desc = "names of both the local & remote queue(s) bound to this address")
String[] getAllQueueNames() throws Exception;
diff --git a/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/message/impl/CoreMessage.java b/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/message/impl/CoreMessage.java
index 7ad2c6becd..781e59e98d 100644
--- a/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/message/impl/CoreMessage.java
+++ b/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/message/impl/CoreMessage.java
@@ -211,7 +211,6 @@ public class CoreMessage extends RefCountMessage implements ICoreMessage {
* This will return the proper buffer to represent the data of the Message. If compressed it will decompress.
* If large, it will read from the file or streaming.
* @return
- * @throws ActiveMQException
*/
@Override
public ActiveMQBuffer getDataBuffer() {
diff --git a/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/server/ComponentConfigurationRoutingType.java b/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/server/ComponentConfigurationRoutingType.java
index 780572e574..d9ad4dd838 100644
--- a/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/server/ComponentConfigurationRoutingType.java
+++ b/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/server/ComponentConfigurationRoutingType.java
@@ -18,7 +18,7 @@ package org.apache.activemq.artemis.core.server;
/**
* This class essentially mirrors {@code RoutingType} except it has some additional members to support special
- * configuration semantics for diverts & bridges. These additional members weren't put in {@code RoutingType}
+ * configuration semantics for diverts and bridges. These additional members weren't put in {@code RoutingType}
* so as to not confuse users.
*/
public enum ComponentConfigurationRoutingType {
diff --git a/artemis-core-client/src/main/java/org/apache/activemq/artemis/spi/core/protocol/RemotingConnection.java b/artemis-core-client/src/main/java/org/apache/activemq/artemis/spi/core/protocol/RemotingConnection.java
index 89452f64b8..f9f4fa508a 100644
--- a/artemis-core-client/src/main/java/org/apache/activemq/artemis/spi/core/protocol/RemotingConnection.java
+++ b/artemis-core-client/src/main/java/org/apache/activemq/artemis/spi/core/protocol/RemotingConnection.java
@@ -240,7 +240,7 @@ public interface RemotingConnection extends BufferHandler {
/**
* Sets the client ID associated with this connection
- * @return
+ * @param cID
*/
void setClientID(String cID);
diff --git a/artemis-dto/pom.xml b/artemis-dto/pom.xml
index e40bafb8f2..1f2bf55918 100644
--- a/artemis-dto/pom.xml
+++ b/artemis-dto/pom.xml
@@ -35,6 +35,10 @@
This class will provide default properties for constructors
* - *| Name | Default Value |
| AMQ_HOST or org.apache.activemq.AMQ_HOST | localhost |
| AMQ_PORT or org.apache.activemq.AMQ_PORT | 61616 |