Skip to content

Commit

Permalink
Javadoc: Use semantic tag <strong> instead of style tag <b>
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Nov 15, 2024
1 parent 5f21803 commit b714d4c
Show file tree
Hide file tree
Showing 135 changed files with 742 additions and 742 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@
* {@link org.apache.commons.configuration2.convert.DefaultListDelimiterHandler DefaultListDelimiterHandler} configured
* with the desired list delimiter character.</li>
* <li>Allows specifying how missing properties are treated. Per default the get methods returning an object will return
* <b>null</b> if the searched property key is not found (and no default value is provided). With the
* <strong>null</strong> if the searched property key is not found (and no default value is provided). With the
* {@code setThrowExceptionOnMissing()} method this behavior can be changed to throw an exception when a requested
* property cannot be found.</li>
* <li>Basic event support. Whenever this configuration is modified registered event listeners are notified. Refer to
Expand Down Expand Up @@ -115,14 +115,14 @@ private static void checkDefaultValueArray(final Class<?> cls, final Object defa
}

/**
* Checks whether the specified value is <b>null</b> and throws an exception in this case. This method is used by
* conversion methods returning primitive Java types. Here values to be returned must not be <b>null</b>.
* Checks whether the specified value is <strong>null</strong> and throws an exception in this case. This method is used by
* conversion methods returning primitive Java types. Here values to be returned must not be <strong>null</strong>.
*
* @param <T> the type of the object to be checked
* @param key the key which caused the problem
* @param value the value to be checked
* @return the passed in value for chaining this method call
* @throws NoSuchElementException if the value is <b>null</b>
* @throws NoSuchElementException if the value is <strong>null</strong>
*/
private static <T> T checkNonNullValue(final String key, final T value) {
if (value == null) {
Expand All @@ -137,7 +137,7 @@ private static <T> T checkNonNullValue(final String key, final T value) {
*
* @param ci the {@code ConfigurationInterpolator} in question
* @param targetConf the target configuration of the searched lookup
* @return the found {@code Lookup} object or <b>null</b>
* @return the found {@code Lookup} object or <strong>null</strong>
*/
private static Lookup findConfigurationLookup(final ConfigurationInterpolator ci, final ImmutableConfiguration targetConf) {
for (final Lookup l : ci.getDefaultLookups()) {
Expand All @@ -150,7 +150,7 @@ private static Lookup findConfigurationLookup(final ConfigurationInterpolator ci

/**
* Handles the default collection for a collection conversion. This method fills the target collection with the content
* of the default collection. Both collections may be <b>null</b>.
* of the default collection. Both collections may be <strong>null</strong>.
*
* @param target the target collection
* @param defaultValue the default collection
Expand Down Expand Up @@ -264,7 +264,7 @@ protected void addPropertyInternal(final String key, final Object value) {
* structure (i.e. the parent-child-relationships will get lost). So when dealing with hierarchical configuration
* objects their {@link BaseHierarchicalConfiguration#clone() clone()} methods should be used.
*
* @param configuration the configuration to be appended (can be <b>null</b>, then this operation will have no effect)
* @param configuration the configuration to be appended (can be <strong>null</strong>, then this operation will have no effect)
* @since 1.5
*/
public void append(final Configuration configuration) {
Expand Down Expand Up @@ -434,7 +434,7 @@ public final boolean containsKey(final String key) {
* {@code containsKey()}. It has to be defined by concrete subclasses.
*
* @param key the key in question
* @return <b>true</b> if this key is contained in this configuration, <b>false</b> otherwise
* @return <strong>true</strong> if this key is contained in this configuration, <strong>false</strong> otherwise
* @since 2.0
*/
protected abstract boolean containsKeyInternal(String key);
Expand Down Expand Up @@ -495,7 +495,7 @@ private <T> T convert(final Class<T> cls, final String key, final T defValue, fi

/**
* Performs a conversion to an array result class. This implementation delegates to the {@link ConversionHandler} to
* perform the actual type conversion. If this results in a <b>null</b> result (because the property is undefined), the
* perform the actual type conversion. If this results in a <strong>null</strong> result (because the property is undefined), the
* default value is returned. It is checked whether the default value is an array with the correct component type. If
* not, an exception is thrown.
*
Expand All @@ -518,7 +518,7 @@ private Object convertToArray(final Class<?> cls, final String key, final Object
* hierarchical configuration objects their {@link BaseHierarchicalConfiguration#clone() clone()} methods should be
* used.
*
* @param configuration the configuration to copy (can be <b>null</b>, then this operation will have no effect)
* @param configuration the configuration to copy (can be <strong>null</strong>, then this operation will have no effect)
* @since 1.5
*/
public void copy(final Configuration configuration) {
Expand Down Expand Up @@ -588,7 +588,7 @@ protected void endWrite() {
* this configuration.
*
* @param ci the {@code ConfigurationInterpolator} in question
* @return the found {@code Lookup} object or <b>null</b>
* @return the found {@code Lookup} object or <strong>null</strong>
*/
private Lookup findConfigurationLookup(final ConfigurationInterpolator ci) {
return findConfigurationLookup(ci, this);
Expand Down Expand Up @@ -635,7 +635,7 @@ public Object getArray(final Class<?> cls, final String key) {

/**
* {@inheritDoc} This implementation delegates to the {@link ConversionHandler} to perform the actual type conversion.
* If this results in a <b>null</b> result (because the property is undefined), the default value is returned. It is
* If this results in a <strong>null</strong> result (because the property is undefined), the default value is returned. It is
* checked whether the default value is an array with the correct component type. If not, an exception is thrown.
*
* @throws IllegalArgumentException if the default value is not a compatible array
Expand Down Expand Up @@ -1137,7 +1137,7 @@ public String[] getStringArray(final String key) {

/**
* Gets the object responsible for synchronizing this configuration. All access to this configuration - both read and
* write access - is controlled by this object. This implementation never returns <b>null</b>. If no
* write access - is controlled by this object. This implementation never returns <strong>null</strong>. If no
* {@code Synchronizer} has been set, a {@link NoOpSynchronizer} is returned. So, per default, instances of
* {@code AbstractConfiguration} are not thread-safe unless a suitable {@code Synchronizer} is set!
*
Expand All @@ -1155,7 +1155,7 @@ public ImmutableConfiguration immutableSubset(final String prefix) {
}

/**
* Initializes the logger. Supports <b>null</b> input. This method can be called by derived classes in order to enable
* Initializes the logger. Supports <strong>null</strong> input. This method can be called by derived classes in order to enable
* logging.
*
* @param log the logger
Expand Down Expand Up @@ -1245,16 +1245,16 @@ public final boolean isEmpty() {
* Actually checks whether this configuration contains data. This method is called by {@code isEmpty()}. It has to be
* defined by concrete subclasses.
*
* @return <b>true</b> if this configuration contains no data, <b>false</b> otherwise
* @return <strong>true</strong> if this configuration contains no data, <strong>false</strong> otherwise
* @since 2.0
*/
protected abstract boolean isEmptyInternal();

/**
* Checks whether the specified object is a scalar value. This method is called by {@code getList()} and
* {@code getStringArray()} if the property requested is not a string, a list, or an array. If it returns <b>true</b>,
* {@code getStringArray()} if the property requested is not a string, a list, or an array. If it returns <strong>true</strong>,
* the calling method transforms the value to a string and returns a list or an array with this single element. This
* implementation returns <b>true</b> if the value is of a wrapper type for a primitive type.
* implementation returns <strong>true</strong> if the value is of a wrapper type for a primitive type.
*
* @param value the value to be checked
* @return a flag whether the value is a scalar
Expand All @@ -1279,7 +1279,7 @@ public boolean isThrowExceptionOnMissing() {
* configuration is locked.
*
* @since 2.0
* @throws NullPointerException if the argument is <b>null</b>
* @throws NullPointerException if the argument is <strong>null</strong>
*/
@Override
public final void lock(final LockMode mode) {
Expand Down Expand Up @@ -1312,8 +1312,8 @@ public void setConfigurationDecoder(final ConfigurationDecoder configurationDeco
* newly created configuration uses a default {@code ConversionHandler} implementation. This can be changed while
* initializing the configuration (e.g. via a builder). Note that access to this property is not synchronized.
*
* @param conversionHandler the {@code ConversionHandler} to be used (must not be <b>null</b>)
* @throws IllegalArgumentException if the {@code ConversionHandler} is <b>null</b>
* @param conversionHandler the {@code ConversionHandler} to be used (must not be <strong>null</strong>)
* @throws IllegalArgumentException if the {@code ConversionHandler} is <strong>null</strong>
* @since 2.0
*/
public void setConversionHandler(final ConversionHandler conversionHandler) {
Expand Down Expand Up @@ -1353,7 +1353,7 @@ public void setDefaultLookups(final Collection<? extends Lookup> lookups) {
}

/**
* {@inheritDoc} This implementation sets the passed in object without further modifications. A <b>null</b> argument is
* {@inheritDoc} This implementation sets the passed in object without further modifications. A <strong>null</strong> argument is
* allowed; this disables interpolation.
*
* @since 2.0
Expand All @@ -1378,8 +1378,8 @@ public final void setInterpolator(final ConfigurationInterpolator ci) {
* exceptions.
* </p>
*
* @param listDelimiterHandler the {@code ListDelimiterHandler} to be used (must not be <b>null</b>)
* @throws IllegalArgumentException if the {@code ListDelimiterHandler} is <b>null</b>
* @param listDelimiterHandler the {@code ListDelimiterHandler} to be used (must not be <strong>null</strong>)
* @throws IllegalArgumentException if the {@code ListDelimiterHandler} is <strong>null</strong>
* @since 2.0
*/
public void setListDelimiterHandler(final ListDelimiterHandler listDelimiterHandler) {
Expand All @@ -1393,7 +1393,7 @@ public void setListDelimiterHandler(final ListDelimiterHandler listDelimiterHand
* Allows setting the logger to be used by this configuration object. This method makes it possible for clients to
* exactly control logging behavior. Per default a logger is set that will ignore all log messages. Derived classes that
* want to enable logging should call this method during their initialization with the logger to be used. It is legal to
* pass a <b>null</b> logger; in this case, logging will be disabled.
* pass a <strong>null</strong> logger; in this case, logging will be disabled.
*
* @param log the new logger
* @since 2.0
Expand Down Expand Up @@ -1429,7 +1429,7 @@ public void setParentInterpolator(final ConfigurationInterpolator parent) {
* should better call {@link #installInterpolator(Map, Collection)} to define the {@code ConfigurationInterpolator} in a
* single step.
*
* @param lookups a map with new {@code Lookup} objects and their prefixes (may be <b>null</b>)
* @param lookups a map with new {@code Lookup} objects and their prefixes (may be <strong>null</strong>)
* @since 2.0
*/
public void setPrefixLookups(final Map<String, ? extends Lookup> lookups) {
Expand Down Expand Up @@ -1476,7 +1476,7 @@ protected void setPropertyInternal(final String key, final Object value) {
* Sets the object responsible for synchronizing this configuration. This method has to be called with a suitable
* {@code Synchronizer} object when initializing this configuration instance in order to make it thread-safe.
*
* @param synchronizer the new {@code Synchronizer}; can be <b>null</b>, then this instance uses a
* @param synchronizer the new {@code Synchronizer}; can be <strong>null</strong>, then this instance uses a
* {@link NoOpSynchronizer}
* @since 2.0
*/
Expand All @@ -1487,8 +1487,8 @@ public final void setSynchronizer(final Synchronizer synchronizer) {

/**
* Allows to set the {@code throwExceptionOnMissing} flag. This flag controls the behavior of property getter methods
* that return objects if the requested property is missing. If the flag is set to <b>false</b> (which is the default
* value), these methods will return <b>null</b>. If set to <b>true</b>, they will throw a
* that return objects if the requested property is missing. If the flag is set to <strong>false</strong> (which is the default
* value), these methods will return <strong>null</strong>. If set to <strong>true</strong>, they will throw a
* {@code NoSuchElementException} exception. Note that getter methods for primitive data types are not affected by this
* flag.
*
Expand Down Expand Up @@ -1567,7 +1567,7 @@ <E extends Throwable> void syncWrite(final FailableRunnable<E> runnable, final b
* {@code LockMode} argument. Subclasses can override these protected methods to perform additional steps when a
* configuration's lock is released.
*
* @throws NullPointerException if the argument is <b>null</b>
* @throws NullPointerException if the argument is <strong>null</strong>
*/
@Override
public final void unlock(final LockMode mode) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ protected AbstractHierarchicalConfiguration(final NodeModel<T> nodeModel) {
* hierarchy. Implementation node: This method performs some book-keeping and then delegates to
* {@code addNodesInternal()}.
*
* @param key the key where the nodes are to be added; can be <b>null</b>, then they are added to the root node
* @param key the key where the nodes are to be added; can be <strong>null</strong>, then they are added to the root node
* @param nodes a collection with the {@code Node} objects to be added
*/
@Override
Expand All @@ -310,7 +310,7 @@ public final void addNodes(final String key, final Collection<? extends T> nodes
* Actually adds a collection of new nodes to this configuration. This method is called by {@code addNodes()}. It can be
* overridden by subclasses that need to adapt this operation.
*
* @param key the key where the nodes are to be added; can be <b>null</b>, then they are added to the root node
* @param key the key where the nodes are to be added; can be <strong>null</strong>, then they are added to the root node
* @param nodes a collection with the {@code Node} objects to be added
* @since 2.0
*/
Expand Down Expand Up @@ -436,7 +436,7 @@ public Object clone() {
/**
* Checks if the specified key is contained in this configuration. Note that for this configuration the term
* &quot;contained&quot; means that the key has an associated value. If there is a node for this key that has no value
* but children (either defined or undefined), this method will still return <b>false </b>.
* but children (either defined or undefined), this method will still return <strong>false </strong>.
*
* @param key the key to be checked
* @return a flag if this key is contained in this configuration
Expand Down Expand Up @@ -468,7 +468,7 @@ protected List<QueryResult<T>> fetchNodeList(final String key) {
}

/**
* Gets the expression engine used by this configuration. This method will never return <b>null</b>; if no specific
* Gets the expression engine used by this configuration. This method will never return <strong>null</strong>; if no specific
* expression engine was set, the default expression engine will be returned.
*
* @return the current expression engine
Expand Down Expand Up @@ -729,7 +729,7 @@ public NodeUpdateData<T> resolveUpdateKey(final T root, final String key, final
* Sets the expression engine to be used by this configuration. All property keys this configuration has to deal with
* will be interpreted by this engine.
*
* @param expressionEngine the new expression engine; can be <b>null</b>, then the default expression engine will be
* @param expressionEngine the new expression engine; can be <strong>null</strong>, then the default expression engine will be
* used
* @since 1.3
*/
Expand Down Expand Up @@ -769,7 +769,7 @@ public String toString() {
*
* @param result the {@code QueryResult}
* @param handler the {@code NodeHandler}
* @return the value of this result (may be <b>null</b>)
* @return the value of this result (may be <strong>null</strong>)
*/
private Object valueFromResult(final QueryResult<T> result, final NodeHandler<T> handler) {
return result.isAttributeResult() ? result.getAttributeValue(handler) : handler.getValue(result.getNode());
Expand Down
Loading

0 comments on commit b714d4c

Please sign in to comment.