Javadoc: Close HTML tags and normalize spelling of 'initialize'.

This commit is contained in:
Gary Gregory 2020-11-19 21:37:18 -05:00
parent 0d10d917d7
commit f6b9e3cd8e
9 changed files with 26 additions and 18 deletions

View File

@ -1831,7 +1831,7 @@ public class MapUtils {
// -------------------------------------------------------------------------
/**
* Gets a new Properties object initialised with the values from a Map. A null input will return an empty properties
* Gets a new Properties object initialized with the values from a Map. A null input will return an empty properties
* object.
* <p>
* A Properties object may only store non-null keys and values, thus if the provided map contains either a key or

View File

@ -77,7 +77,7 @@ public abstract class AbstractDualBidiMap<K, V> implements BidiMap<K, V> {
transient Set<Map.Entry<K, V>> entrySet = null;
/**
* Creates an empty map, initialised by {@code createMap}.
* Creates an empty map, initialized by {@code createMap}.
* <p>
* This constructor remains in place for deserialization.
* All other usage is deprecated in favour of

View File

@ -35,15 +35,15 @@ public interface HashFunctionIdentity {
* {@link HashFunction#apply(byte[], int)}.</dd>
* <dt>Cyclic processes</dt>
* <dd>Call the underlying hash algorithm using a (buffer, seed) pair passed to
* {@link HashFunction#apply(byte[], int)} to initialise the state. Subsequent
* {@link HashFunction#apply(byte[], int)} to initialize the state. Subsequent
* calls can generate hash values without calling the underlying algorithm.</dd>
* </dl>
*/
enum ProcessType {
/**
* Call the underlying hash algorithm for a (buffer, seed) pair passed to
* {@link HashFunction#apply(byte[], int)} when the state is uninitialised or
* the seed is zero. This initialises the state. Subsequent calls with a non-zero
* {@link HashFunction#apply(byte[], int)} when the state is uninitialized or
* the seed is zero. This initializes the state. Subsequent calls with a non-zero
* seed use the state to generate a new value.
*/
CYCLIC,
@ -71,8 +71,10 @@ public interface HashFunctionIdentity {
* The result of {@link HashFunction#apply(byte[], int)} is signed,
* thus the sign bit may be set.
*
* <p>The result can be used with {@code Math.floorMod(x, y)} to generate a positive
* <p>
* The result can be used with {@code Math.floorMod(x, y)} to generate a positive
* value if y is positive.
* </p>
*
* @see Math#floorMod(int, int)
*/
@ -81,8 +83,10 @@ public interface HashFunctionIdentity {
* The result of {@link HashFunction#apply(byte[], int)} is unsigned,
* thus the sign bit is never set.
*
* <p>The result can be used with {@code x % y} to generate a positive
* <p>
* The result can be used with {@code x % y} to generate a positive
* value if y is positive.
* </p>
*/
UNSIGNED
}
@ -119,9 +123,11 @@ public interface HashFunctionIdentity {
/**
* Gets the name of this hash function.
* <p> Hash function should be the common name
* <p>
* Hash function should be the common name
* for the hash. This may include indications as to hash length
* </p><p>
* </p>
* <p>
* Names are not case specific. Thus, "MD5" and "md5" should be considered as the same.
* </p>
* @return the Hash name
@ -149,7 +155,9 @@ public interface HashFunctionIdentity {
* Gets the signature of this function. The signature is the output of the hash function
* when applied to a set of bytes composed using properties of the hash function.
*
* <p>Implementations should define the method used to generate the signature.
* <p>
* Implementations should define the method used to generate the signature.
* </p>
*
* @return the signature of this function.
* @see #prepareSignatureBuffer(HashFunctionIdentity)

View File

@ -93,7 +93,7 @@ public abstract class AbstractLinkedList<E> implements List<E> {
* The equivalent of a default constructor, broken out so it can be called
* by any constructor and by {@code readObject}.
* Subclasses which override this method should make sure they call super,
* so the list is initialised properly.
* so the list is initialized properly.
*/
protected void init() {
header = createHeaderNode();

View File

@ -89,7 +89,7 @@ public class SetUniqueList<E> extends AbstractSerializableListDecorator<E> {
/**
* Constructor that wraps (not copies) the List and specifies the set to use.
* <p>
* The set and list must both be correctly initialised to the same elements.
* The set and list must both be correctly initialized to the same elements.
*
* @param set the set to decorate, must not be null
* @param list the list to decorate, must not be null

View File

@ -1246,7 +1246,7 @@ public class AbstractHashedMap<K, V> extends AbstractMap<K, V> implements Iterab
* subclass must be setup before {@code put()} is used.
* <p>
* Serialization is not one of the JDK's nicest topics. Normal serialization will
* initialise the superclass before the subclass. Sometimes however, this isn't
* initialize the superclass before the subclass. Sometimes however, this isn't
* what you want, as in this case the {@code put()} method on read can be
* affected by subclass state.
* <p>
@ -1276,7 +1276,7 @@ public class AbstractHashedMap<K, V> extends AbstractMap<K, V> implements Iterab
* subclass must be setup before {@code put()} is used.
* <p>
* Serialization is not one of the JDK's nicest topics. Normal serialization will
* initialise the superclass before the subclass. Sometimes however, this isn't
* initialize the superclass before the subclass. Sometimes however, this isn't
* what you want, as in this case the {@code put()} method on read can be
* affected by subclass state.
* <p>

View File

@ -1007,7 +1007,7 @@ public abstract class AbstractReferenceMap<K, V> extends AbstractHashedMap<K, V>
* Replaces the superclass method to store the state of this class.
* <p>
* Serialization is not one of the JDK's nicest topics. Normal serialization will
* initialise the superclass before the subclass. Sometimes however, this isn't
* initialize the superclass before the subclass. Sometimes however, this isn't
* what you want, as in this case the {@code put()} method on read can be
* affected by subclass state.
* <p>
@ -1041,7 +1041,7 @@ public abstract class AbstractReferenceMap<K, V> extends AbstractHashedMap<K, V>
* Replaces the superclass method to read the state of this class.
* <p>
* Serialization is not one of the JDK's nicest topics. Normal serialization will
* initialise the superclass before the subclass. Sometimes however, this isn't
* initialize the superclass before the subclass. Sometimes however, this isn't
* what you want, as in this case the {@code put()} method on read can be
* affected by subclass state.
* <p>

View File

@ -152,7 +152,7 @@ public class ListOrderedSet<E>
* Constructor that wraps (not copies) the Set and specifies the list to
* use.
* <p>
* The set and list must both be correctly initialised to the same elements.
* The set and list must both be correctly initialized to the same elements.
*
* @param set the set to decorate, must not be null
* @param list the list to decorate, must not be null

View File

@ -27,7 +27,7 @@ public abstract class AbstractPredicateTest {
protected Integer cInteger;
@Before
public void initialiseTestObjects() throws Exception {
public void initializeTestObjects() throws Exception {
cObject = new Object();
cString = "Hello";
cInteger = Integer.valueOf(6);