Merge branch 'master' into release/5.0.0

afs/afs/pom.xml

@@ -13,6 +13,9 @@
 
 	<artifactId>microstream-afs</artifactId>
 
+	<name>MicroStream Abstract File System</name>
+	<description>Abstract File System Implementation</description>
+
 	<dependencies>
 		<dependency>
 			<groupId>one.microstream</groupId>

afs/afs/src/main/java/one/microstream/afs/types/ADirectory.java

@@ -156,7 +156,6 @@ public default boolean exists()
 
 	/**
 	 * Removes all child items ({@link ADirectory} or {@link AFile}) that have no physical equivalent.
-	 * @return
 	 */
 	public int consolidate();
 

afs/afs/src/main/java/one/microstream/afs/types/AItem.java

@@ -57,14 +57,9 @@ public interface AItem
 
 	/**
 	 * The value that uniquely identifies the item locally in its {@link #parent()} directory.
-	 * <p>
-	 * Note that this value might be a combination of {@link #name()} and {@link #type()},
-	 * but such a relation is not mandatory.
 	 * 
 	 * @see #parent()
 	 * @see #toPathString()
-	 * @see #name()
-	 * @see #type()
 	 * 
 	 * @return the item's locally unique identifier.
 	 */

afs/afs/src/main/java/one/microstream/afs/types/ARoot.java

@@ -61,7 +61,6 @@ public default String protocol()
 	 * @param protocol
 	 * @param identifier
 	 * 
-	 * @return
 	 */
 	public static ARoot New(
 		final AFileSystem fileSystem,

afs/nio/pom.xml

@@ -12,7 +12,10 @@
 	</parent>
 
 	<artifactId>microstream-afs-nio</artifactId>
-
+
+	<name>MicroStream Abstract File System - Java NIO</name>
+	<description>Java NIO Adapter for the MicroStream Abstract File System</description>
+
 	<dependencies>
 		<dependency>
 			<groupId>one.microstream</groupId>

afs/pom.xml

@@ -15,6 +15,9 @@
 
 	<artifactId>microstream-afs-parent</artifactId>
 	<packaging>pom</packaging>
+
+	<name>MicroStream Abstract File System</name>
+	<description>File System Abstraction Project</description>
 
 	<modules>
 		<module>afs</module>

afs/sql/pom.xml

@@ -13,6 +13,9 @@
 
 	<artifactId>microstream-afs-sql</artifactId>
 
+	<name>MicroStream Abstract File System - SQL</name>
+	<description>SQL Adapter for the MicroStream Abstract File System</description>
+
 	<dependencies>
 		<dependency>
 			<groupId>one.microstream</groupId>

base/pom.xml

@@ -14,5 +14,8 @@
 	</parent>
 
 	<artifactId>microstream-base</artifactId>
+
+	<name>MicroStream Base</name>
+	<description>Commons Module of the MicroStream Framework</description>
 
 </project>

base/src/main/java/one/microstream/X.java

@@ -999,7 +999,6 @@ public static <T> WeakReference<T>[] WeakReferences(final T... referents)
 	 * 
 	 * @param <T>
 	 * @param array
-	 * @return
 	 */
 	public static <T> WeakReference<T>[] consolidateWeakReferences(final WeakReference<T>[] array)
 	{

base/src/main/java/one/microstream/chars/XChars.java

@@ -224,7 +224,7 @@ public static final boolean isNonWhitespace(final char c)
 	 * Arbitrary threshold of 1000 to discrimate "short" strings from "long" strings.<br>
 	 * The rationale behind that is that "short" strings usually allow for simpler and faster algorithms,
 	 * which become inefficient on larger strings. For example a two-pass processing of a splitting algorithm.
-	 * @return
+	 * @return 1000
 	 */
 	public static final int shortStringLength()
 	{
@@ -253,8 +253,8 @@ public static final Charset standardCharset()
 
 	/**
 	 * Alias for {@link Charset#defaultCharset()}, which returns sometimes the one thing and sometimes another.
-	 * It is strongly advised to use a reliable {@link Charset} querying method, like {@link utf8}, which also
-	 * is the only reasonable choice for the {@link standardCharset}.
+	 * It is strongly advised to use a reliable {@link Charset} querying method, like UTF-8, which also
+	 * is the only reasonable choice for the standard charset.
 	 * 
 	 * @return {@link Charset#defaultCharset()}
 	 */

base/src/main/java/one/microstream/collections/BulkList.java

@@ -180,7 +180,7 @@ public static final <E> BulkList<E> NewFromSingle(final E initialElement)
 	 * Pseudo-constructor method to create a new {@link BulkList} instance containing all elements of the passed
 	 * array. The element size of the new instance will be equal to the passed arrays length.
 	 *
-	 * @param elements the initial elements for the new instance.
+	 * @param initialElements the initial elements for the new instance.
 	 * @return a new {@link BulkList} instance.
 	 * @throws NullPointerException if an explicit {@code null} array reference was passed.
 	 */
@@ -193,7 +193,7 @@ public static final <E> BulkList<E> New(final E... initialElements)
 	/**
 	 * Pseudo-constructor method to create a new {@link BulkList} instance and adds all the given elements to it.
 	 *
-	 * @param elements to add to the created instance
+	 * @param initialElements to add to the created instance
 	 * @return a new {@link BulkList} instance.
 	 */
 	public static final <E> BulkList<E> New(final XIterable<? extends E> initialElements)
@@ -206,7 +206,7 @@ public static final <E> BulkList<E> New(final XIterable<? extends E> initialElem
 	/**
 	 * Pseudo-constructor method to create a new {@link BulkList} instance and adds all the given elements to it.
 	 *
-	 * @param elements to add to the created instance
+	 * @param initialElements to add to the created instance
 	 * @return a new {@link BulkList} instance.
 	 */
 	public static final <E> BulkList<E> New(final Iterable<? extends E> initialElements)
@@ -220,7 +220,7 @@ public static final <E> BulkList<E> New(final Iterable<? extends E> initialEleme
 	 * Pseudo-constructor method to create a new {@link BulkList} instance with the needed amount of capacity and adds all
 	 * elements to it.
 	 *
-	 * @param elements to add to the created instance
+	 * @param initialElements to add to the created instance
 	 * @return a new {@link BulkList} instance.
 	 */
 	public static final <E> BulkList<E> New(final XGettingCollection<? extends E> initialElements)
@@ -784,7 +784,7 @@ public final <P extends Consumer<? super E>> P iterate(final P procedure)
 
 	/**
 	 * {@inheritDoc}
-	 * @see {@link AbstractArrayStorage#join}
+	 * @see AbstractArrayStorage#join(Object[], int, BiConsumer, Object)
 	 */
 	@Override
 	public final <A> A join(final BiConsumer<? super E, ? super A> joiner, final A aggregate)

base/src/main/java/one/microstream/collections/EqBulkList.java

@@ -627,7 +627,8 @@ public final <P extends IndexedAcceptor<? super E>> P iterateIndexed(final P pro
 
 	/**
 	 * {@inheritDoc}
-	 * @see {@link AbstractArrayStorage#join}
+	 * 
+	 * @see AbstractArrayStorage#join(Object[], int, BiConsumer, Object)
 	 */
 	@Override
 	public final <A> A join(final BiConsumer<? super E, ? super A> joiner, final A aggregate)

base/src/main/java/one/microstream/collections/types/XJoinable.java

@@ -22,6 +22,10 @@
 
 import java.util.function.BiConsumer;
 
+/**
+ * 
+ * @param <E> type of data to join
+ */
 public interface XJoinable<E>
 {
 	/**
@@ -30,7 +34,6 @@ public interface XJoinable<E>
 	 * 
 	 * @param joiner is the actual function to do the joining
 	 * @param aggregate where to join into
-	 * @param <E> type of data to join
 	 * @param <A> type of aggregate
 	 */
 	public <A> A join(BiConsumer<? super E, ? super A> joiner, A aggregate);

base/src/main/java/one/microstream/concurrency/Threaded.java

@@ -332,7 +332,6 @@ public E remove()
 	 *
 	 * @return {@code null}.
 	 * @see #get()
-	 * @see #addForCurrentThread(Object)
 	 */
 	protected E lookupMissFallbackElement()
 	{

base/src/main/java/one/microstream/io/XIO.java

@@ -485,7 +485,6 @@ public static <C extends Consumer<? super Path>> C listEntries(
 	 * @param <C>
 	 * @param directory
 	 * @param logic
-	 * @return
 	 * @throws IOException
 	 */
 	public static <C extends Consumer<? super Path>> C iterateEntries(
@@ -506,7 +505,6 @@ public static <C extends Consumer<? super Path>> C iterateEntries(
 	 * @param directory
 	 * @param logic
 	 * @param selector
-	 * @return
 	 * @throws IOException
 	 */
 	public static <C extends Consumer<? super Path>> C iterateEntries(
@@ -674,7 +672,6 @@ public static final <T> T readOneShot(final Path file, final IoOperationSR<FileC
 	 * strings right away?
 	 * 
 	 * @param filePath
-	 * @return
 	 * @throws IOException
 	 */
 	public static String readString(final String filePath)
@@ -693,7 +690,6 @@ public static String readString(final String filePath)
 	 * 
 	 * @param filePath
 	 * @param charSet
-	 * @return
 	 * @throws IOException
 	 */
 	public static String readString(final String filePath, final Charset charSet)
@@ -1308,7 +1304,7 @@ public static long copyFile(
 	 * @throws IOException as specified by {@link FileChannel#transferFrom(java.nio.channels.ReadableByteChannel, long, long)}
 	 * 
 	 * @see FileChannel#transferFrom(java.nio.channels.ReadableByteChannel, long, long)
-	 * @see #copyFile(Path, Path)
+	 * @see #copyFile(Path, Path, OpenOption...)
 	 */
 	public static long copyFile(
 		final FileChannel sourceChannel,
@@ -1324,7 +1320,6 @@ public static long copyFile(
 	 * @param sourceChannel
 	 * @param targetChannel
 	 * @param targetPosition
-	 * @return
 	 * @throws IOException
 	 */
 	public static long copyFile(
@@ -1578,7 +1573,6 @@ public static final <C extends Consumer<? super Path>> C listEntries(
 		 * @param <C>
 		 * @param directory
 		 * @param logic
-		 * @return
 		 * @throws IORuntimeException
 		 */
 		public static <C extends Consumer<? super Path>> C iterateEntries(
@@ -1606,7 +1600,6 @@ public static <C extends Consumer<? super Path>> C iterateEntries(
 		 * @param directory
 		 * @param logic
 		 * @param selector
-		 * @return
 		 * @throws IORuntimeException
 		 */
 		public static <C extends Consumer<? super Path>> C iterateEntries(

base/src/main/java/one/microstream/memory/MemoryAccessor.java

@@ -277,7 +277,6 @@ public default byte[] asByteArray(final long value)
 	 * 
 	 * @param objectClass
 	 * @param field
-	 * @return
 	 */
 	public long objectFieldOffset(Class<?> objectClass, Field field);
 

base/src/main/java/one/microstream/reflect/ReflectiveCopier.java

@@ -45,7 +45,6 @@ public default <T extends S> T copyTo(final T targetInstance)
 
 	/**
 	 * Does not necessarily have to be S. S could be an interface.
-	 * @return
 	 */
 	public Class<?> sourceClass();
 

base/src/main/java/one/microstream/reflect/XReflect.java

@@ -802,8 +802,6 @@ public static final Class<?> resolveType(final String typeName, final ClassLoade
 	 *
 	 * @param typeName
 	 *
-	 * @return
-	 *
 	 * @throws LinkageError
 	 * @throws ExceptionInInitializerError
 	 * @throws ClassNotFoundException
@@ -935,7 +933,6 @@ public static final ClassLoader defaultTypeResolvingClassLoader()
 	 * Make sure this is a suitable {@link ClassLoader} when using this method.
 	 *
 	 * @param typeName
-	 * @return
 	 */
 	public static final Class<?> resolveType(final String typeName)
 		throws LinkageError, ExceptionInInitializerError, ClassNotFoundException
@@ -948,7 +945,6 @@ public static final Class<?> resolveType(final String typeName)
 	 * Make sure this is a suitable {@link ClassLoader} when using this method.
 	 *
 	 * @param className
-	 * @return
 	 */
 	public static final Class<?> tryResolveType(final String className)
 	{
@@ -960,7 +956,6 @@ public static final Class<?> tryResolveType(final String className)
 	 * Make sure this is a suitable {@link ClassLoader} when using this method.
 	 *
 	 * @param typeNames
-	 * @return
 	 */
 	public static final Class<?> iterativeResolveType(final String... typeNames)
 		throws ClassNotFoundException

base/src/main/java/one/microstream/util/BundleInfo.java

@@ -64,7 +64,6 @@ public static BundleInfo LoadBase()
 	/**
 	 * 
 	 * @param bundleName the name of the bundle, in Maven environments the artifact id
-	 * @return
 	 */
 	public static BundleInfo Load(final String bundleName)
 	{

cache/cache/pom.xml

@@ -14,6 +14,9 @@
 	</parent>
 
 	<artifactId>microstream-cache</artifactId>
+
+	<name>MicroStream Cache</name>
+	<description>JSR-107 (JCache) Implementation</description>
 
 	<dependencies>
 		<dependency>

cache/hibernate/pom.xml

@@ -15,6 +15,9 @@
 
 	<artifactId>microstream-cache-hibernate</artifactId>
 
+	<name>MicroStream Cache for Hibernate</name>
+	<description>Hibernate Cache Region Factory</description>
+
 	<dependencies>
 		<dependency>
 			<groupId>one.microstream</groupId>

cache/pom.xml

@@ -15,6 +15,9 @@
 
 	<artifactId>microstream-cache-parent</artifactId>
 	<packaging>pom</packaging>
+
+	<name>MicroStream Cache</name>
+	<description>MicroStream Cache Project</description>
 
 	<modules>
 		<module>cache</module>

communication/binary/pom.xml

@@ -13,6 +13,9 @@
 
 	<artifactId>microstream-communication-binary</artifactId>
 
+	<name>MicroStream Communication Binary</name>
+	<description>MicroStream Object Graph Communication Binary Implementation</description>
+
 	<dependencies>
 		<dependency>
 			<groupId>one.microstream</groupId>

communication/communication/pom.xml

@@ -13,6 +13,9 @@
 
 	<artifactId>microstream-communication</artifactId>
 
+	<name>MicroStream Communication</name>
+	<description>MicroStream Object Graph Communication</description>
+
 	<dependencies>
 		<dependency>
 			<groupId>one.microstream</groupId>

communication/pom.xml

@@ -15,6 +15,9 @@
 
 	<artifactId>microstream-communication-parent</artifactId>
 	<packaging>pom</packaging>
+
+	<name>MicroStream Communication</name>
+	<description>MicroStream Communication Project</description>
 
 	<modules>
 		<module>communication</module>

configuration/configuration/pom.xml

@@ -12,6 +12,9 @@
 	</parent>
 
 	<artifactId>microstream-configuration</artifactId>
+
+	<name>MicroStream Configuration</name>
+	<description>MicroStream General Purpose Configuration</description>
 
 	<dependencies>
 		<dependency>

configuration/configuration/src/main/java/one/microstream/configuration/types/ByteUnit.java

@@ -127,7 +127,6 @@ private ByteUnit(
 	 * Returns the number of bytes, which this unit multiplied by <code>value</code> yield
 	 * 
 	 * @param value
-	 * @return
 	 */
 	public long toBytes(
 		final double value