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 c0ab89b commit 1231b38
Show file tree
Hide file tree
Showing 59 changed files with 189 additions and 188 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -253,8 +253,8 @@ public boolean isReadOnly() {
* </p>
*
* <p>
* <b>N.B.</b>For {@link DynaBean}s whose associated {@link DynaClass} is a {@link MutableDynaClass} a new Set is created every time, otherwise the Set is
* created only once and cached.
* <strong>N.B.</strong>For {@link DynaBean}s whose associated {@link DynaClass} is a {@link MutableDynaClass} a new Set is created every time, otherwise
* the Set is created only once and cached.
* </p>
*
* @return An unmodifiable set of the {@link DynaBean}s property names.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ protected DynaProperty getDynaProperty(final String name) {
* <p>
* This, for example, could be used in JSTL in the following way to access a DynaBean's {@code fooProperty}:
* <ul>
* <li>{@code ${myDynaBean.<b>map</b>.fooProperty}}</li>
* <li>{@code ${myDynaBean.<strong>map</strong>.fooProperty}}</li>
* </ul>
*
* @return a Map representation of this DynaBean
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,10 +85,10 @@ public BeanIntrospectionData(final PropertyDescriptor[] descs) {
}

/**
* Returns the {@code PropertyDescriptor} for the property with the specified name. If this property is unknown, result is <b>null</b>.
* Returns the {@code PropertyDescriptor} for the property with the specified name. If this property is unknown, result is <strong>null</strong>.
*
* @param name the name of the property in question
* @return the {@code PropertyDescriptor} for this property or <b>null</b>
* @return the {@code PropertyDescriptor} for this property or <strong>null</strong>
*/
public PropertyDescriptor getDescriptor(final String name) {
for (final PropertyDescriptor pd : getDescriptors()) {
Expand Down Expand Up @@ -116,7 +116,7 @@ public PropertyDescriptor[] getDescriptors() {
*
* @param beanCls the class of the affected bean
* @param desc the {@code PropertyDescriptor} of the desired property
* @return the write method for this property or <b>null</b> if there is none
* @return the write method for this property or <strong>null</strong> if there is none
*/
public Method getWriteMethod(final Class<?> beanCls, final PropertyDescriptor desc) {
Method method = desc.getWriteMethod();
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/org/apache/commons/beanutils2/BeanMap.java
Original file line number Diff line number Diff line change
Expand Up @@ -515,7 +515,8 @@ public Iterator<String> keyIterator() {
/**
* Gets the keys for this BeanMap.
* <p>
* Write-only properties are <b>not</b> included in the returned set of property names, although it is possible to set their value and to get their type.
* Write-only properties are <strong>not</strong> included in the returned set of property names, although it is possible to set their value and to get
* their type.
* </p>
*
* @return BeanMap keys. The Set returned by this method is not modifiable.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ protected <R> Object convert(final Object value, final Class<R> type) {

/**
* Performs a type conversion of a property value before it is copied to a target bean. This method delegates to {@link #convert(Object, Class)}, but
* <b>null</b> values are not converted. This causes <b>null</b> values to be copied verbatim.
* <strong>null</strong> values are not converted. This causes <strong>null</strong> values to be copied verbatim.
*
* @param value the value to be converted and copied
* @param type the target type of the conversion
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
* This, for example, could be used in JSTL in the following way to access a DynaBean's {@code fooProperty}:
* </p>
* <ul>
* <li>{@code ${myDynaBean.<b>map</b>.fooProperty}}</li>
* <li>{@code ${myDynaBean.<strong>map</strong>.fooProperty}}</li>
* </ul>
*
* <h2>Usage</h2>
Expand All @@ -56,8 +56,8 @@
* </ul>
*
* <p>
* The above example creates a <b><em>read only</em></b> {@code Map}. To create a {@code Map} which can be modified, construct a
* {@code DynaBeanPropertyMapDecorator} with the <b><em>read only</em></b> attribute set to {@code false}:
* The above example creates a <strong><em>read only</em></strong> {@code Map}. To create a {@code Map} which can be modified, construct a
* {@code DynaBeanPropertyMapDecorator} with the <strong><em>read only</em></strong> attribute set to {@code false}:
* </p>
*
* <ul>
Expand All @@ -68,7 +68,7 @@
* <h2>Limitations</h2>
* <p>
* In this implementation the {@code entrySet()</code>, <code>keySet()}
* and {@code values()} methods create an <b><em>unmodifiable</em></b>
* and {@code values()} methods create an <strong><em>unmodifiable</em></strong>
* {@code Set</code> and it does not support the Map's <code>clear()} and {@code remove()} operations.
* </p>
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@
* </p>
* <p>
* A <em>fluent API</em> allows setting multiple properties using a single statement by supporting so-called <em>method chaining</em>: Methods for setting a
* property value do not return <b>void</b>, but an object which can be called for setting another property. An example of such a fluent API could look as
* follows:
* property value do not return <strong>void</strong>, but an object which can be called for setting another property. An example of such a fluent API could
* look as follows:
* </p>
*
* <pre>
Expand All @@ -51,7 +51,7 @@
* </pre>
*
* <p>
* Per default, {@code PropertyUtils} does not detect methods like this because, having a non-<b>void</b> return type, they violate the Java Beans
* Per default, {@code PropertyUtils} does not detect methods like this because, having a non-<strong>void</strong> return type, they violate the Java Beans
* specification.
* </p>
* <p>
Expand All @@ -62,8 +62,8 @@
* <p>
* An instance of this class is intended to collaborate with a {@link DefaultBeanIntrospector} object. So best results are achieved by adding this instance as
* custom {@code BeanIntrospector} after the {@code DefaultBeanIntrospector} object. Then default introspection finds read-only properties because it does not
* detect the write methods with a non-<b>void</b> return type. {@code FluentPropertyBeanIntrospector} completes the descriptors for these properties by setting
* the correct write method.
* detect the write methods with a non-<strong>void</strong> return type. {@code FluentPropertyBeanIntrospector} completes the descriptors for these properties
* by setting the correct write method.
* </p>
*
* @since 1.9
Expand Down Expand Up @@ -91,8 +91,8 @@ public FluentPropertyBeanIntrospector() {
* Creates a new instance of {@code FluentPropertyBeanIntrospector} and initializes it with the prefix for write methods used by the classes to be
* inspected.
*
* @param writePrefix the prefix for write methods (must not be <b>null</b>)
* @throws IllegalArgumentException if the prefix is <b>null</b>
* @param writePrefix the prefix for write methods (must not be <strong>null</strong>)
* @throws IllegalArgumentException if the prefix is <strong>null</strong>
*/
public FluentPropertyBeanIntrospector(final String writePrefix) {
writeMethodPrefix = Objects.requireNonNull(writePrefix, "writePrefix");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,10 @@ public interface IntrospectionContext {
void addPropertyDescriptors(PropertyDescriptor[] descriptors);

/**
* Returns the descriptor for the property with the given name or <b>null</b> if this property is unknown.
* Returns the descriptor for the property with the given name or <strong>null</strong> if this property is unknown.
*
* @param name the name of the property in question
* @return the descriptor for this property or <b>null</b> if this property is unknown
* @return the descriptor for this property or <strong>null</strong> if this property is unknown
*/
PropertyDescriptor getPropertyDescriptor(String name);

Expand All @@ -68,7 +68,7 @@ public interface IntrospectionContext {
* that an already existing property descriptor is overridden.
*
* @param name the name of the property in question
* @return <b>true</b> if a descriptor for this property has already been added, <b>false</b> otherwise
* @return <strong>true</strong> if a descriptor for this property has already been added, <strong>false</strong> otherwise
*/
boolean hasProperty(String name);

Expand Down
20 changes: 10 additions & 10 deletions src/main/java/org/apache/commons/beanutils2/LazyDynaBean.java
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,11 @@
* {@code set(name, key, value)}</li>
* </ul>
*
* <p><b><u>Getting Property Values</u></b></p>
* <p><strong><u>Getting Property Values</u></strong></p>
* <p>Calling any of the {@code get()} methods, for a property which
* doesn't exist, returns {@code null} in this implementation.</p>
*
* <p><b><u>Setting Simple Properties</u></b></p>
* <p><strong><u>Setting Simple Properties</u></strong></p>
* <p>The {@code LazyDynaBean</code> will automatically add a property to the <code>DynaClass}
* if it doesn't exist when the {@code set(name, value)} method is called.</p>
*
Expand All @@ -60,8 +60,8 @@
* myBean.set("myProperty", "myValue");
* }</pre>
*
* <p><b><u>Setting Indexed Properties</u></b></p>
* <p>If the property <b>doesn't</b> exist, the {@code LazyDynaBean} will automatically add
* <p><strong><u>Setting Indexed Properties</u></strong></p>
* <p>If the property <strong>doesn't</strong> exist, the {@code LazyDynaBean} will automatically add
* a property with an {@code ArrayList</code> type to the <code>DynaClass} when
* the {@code set(name, index, value)} method is called.
* It will also instantiate a new {@code ArrayList} and automatically <em>grow</em>
Expand All @@ -76,7 +76,7 @@
* myBean.set("myIndexedProperty", 1, "myValue2");
* }</pre>
*
* <p>If the indexed property <b>does</b> exist in the {@code DynaClass} but is set to
* <p>If the indexed property <strong>does</strong> exist in the {@code DynaClass} but is set to
* {@code null</code> in the <code>LazyDynaBean}, then it will instantiate a
* new {@code List</code> or <code>Array} as specified by the property's type
* in the {@code DynaClass</code> and automatically <em>grow</em> the <code>List}
Expand All @@ -90,8 +90,8 @@
* myBean.set("myIndexedProperty", 1, Integer.valueOf(20));
* }</pre>
*
* <p><b><u>Setting Mapped Properties</u></b></p>
* <p>If the property <b>doesn't</b> exist, the {@code LazyDynaBean} will automatically add
* <p><strong><u>Setting Mapped Properties</u></strong></p>
* <p>If the property <strong>doesn't</strong> exist, the {@code LazyDynaBean} will automatically add
* a property with a {@code HashMap</code> type to the <code>DynaClass} and
* instantiate a new {@code HashMap} in the DynaBean when the
* {@code set(name, key, value)</code> method is called. <code>HashMap} is the default
Expand All @@ -103,7 +103,7 @@
* myBean.set("myMappedProperty", "myKey", "myValue");
* }</pre>
*
* <p>If the mapped property <b>does</b> exist in the {@code DynaClass} but is set to
* <p>If the mapped property <strong>does</strong> exist in the {@code DynaClass} but is set to
* {@code null</code> in the <code>LazyDynaBean}, then it will instantiate a
* new {@code Map</code> as specified by the property's type in the <code>DynaClass}.</p>
*
Expand All @@ -114,7 +114,7 @@
* myBean.set("myMappedProperty", "myKey", "myValue");
* }</pre>
*
* <p><b><u><em>Restricted</em> DynaClass</u></b></p>
* <p><strong><u><em>Restricted</em> DynaClass</u></strong></p>
* <p>{@code MutableDynaClass</code> have a facility to <em>restrict</em> the <code>DynaClass} so that its properties cannot be modified. If the
* {@code MutableDynaClass} is restricted then calling any of the {@code set()} methods for a property which doesn't exist will result in a
* {@code IllegalArgumentException} being thrown.
Expand Down Expand Up @@ -577,7 +577,7 @@ public DynaClass getDynaClass() {
* </p>
* This, for example, could be used in JSTL in the following way to access a DynaBean's {@code fooProperty}:
* <ul>
* <li>{@code ${myDynaBean.<b>map</b>.fooProperty}}</li>
* <li>{@code ${myDynaBean.<strong>map</strong>.fooProperty}}</li>
* </ul>
*
* @return a Map representation of this DynaBean
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
* <li>Mapped properties are automatically instantiated.</li>
* </ul>
*
* <p><b><u><em>Restricted</em> DynaClass</u></b></p>
* <p><strong><u><em>Restricted</em> DynaClass</u></strong></p>
* <p>This class implements the {@code MutableDynaClass} interface.
* {@code MutableDynaClass</code> have a facility to <em>restrict</em> the <code>DynaClass} so that its properties cannot be modified. If the
* {@code MutableDynaClass} is restricted then calling any of the {@code set()} methods for a property which doesn't exist will result in a
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ public class PropertyUtils {
/**
* Adds a {@code BeanIntrospector}. This object is invoked when the property descriptors of a class need to be obtained.
*
* @param introspector the {@code BeanIntrospector} to be added (must not be <b>null</b>
* @throws IllegalArgumentException if the argument is <b>null</b>
* @param introspector the {@code BeanIntrospector} to be added (must not be <strong>null</strong>
* @throws IllegalArgumentException if the argument is <strong>null</strong>
* @since 1.9
*/
public static void addBeanIntrospector(final BeanIntrospector introspector) {
Expand Down Expand Up @@ -486,7 +486,7 @@ public static boolean isWriteable(final Object bean, final String name) {
* Removes the specified {@code BeanIntrospector}.
*
* @param introspector the {@code BeanIntrospector} to be removed
* @return <b>true</b> if the {@code BeanIntrospector} existed and could be removed, <b>false</b> otherwise
* @return <strong>true</strong> if the {@code BeanIntrospector} existed and could be removed, <strong>false</strong> otherwise
* @since 1.9
*/
public static boolean removeBeanIntrospector(final BeanIntrospector introspector) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,8 @@ public PropertyUtilsBean() {
/**
* Adds a {@code BeanIntrospector}. This object is invoked when the property descriptors of a class need to be obtained.
*
* @param introspector the {@code BeanIntrospector} to be added (must not be <b>null</b>
* @throws IllegalArgumentException if the argument is <b>null</b>
* @param introspector the {@code BeanIntrospector} to be added (must not be <strong>null</strong>
* @throws IllegalArgumentException if the argument is <strong>null</strong>
* @since 1.9
*/
public void addBeanIntrospector(final BeanIntrospector introspector) {
Expand Down Expand Up @@ -422,7 +422,7 @@ public Object getIndexedProperty(final Object bean, final String name, final int
*
* @param beanClass the bean class in question
* @return the {@code BeanIntrospectionData} object for this class
* @throws IllegalArgumentException if the bean class is <b>null</b>
* @throws IllegalArgumentException if the bean class is <strong>null</strong>
*/
private BeanIntrospectionData getIntrospectionData(final Class<?> beanClass) {
Objects.requireNonNull(beanClass, "beanClass");
Expand Down Expand Up @@ -1204,7 +1204,7 @@ public boolean isWriteable(Object bean, String name) {
* Removes the specified {@code BeanIntrospector}.
*
* @param introspector the {@code BeanIntrospector} to be removed
* @return <b>true</b> if the {@code BeanIntrospector} existed and could be removed, <b>false</b> otherwise
* @return <strong>true</strong> if the {@code BeanIntrospector} existed and could be removed, <strong>false</strong> otherwise
* @since 1.9
*/
public boolean removeBeanIntrospector(final BeanIntrospector introspector) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ public class SuppressPropertiesBeanIntrospector implements BeanIntrospector {
/**
* Creates a new instance of {@code SuppressPropertiesBeanIntrospector} and sets the names of the properties to be suppressed.
*
* @param propertiesToSuppress the names of the properties to be suppressed (must not be <b>null</b>)
* @throws IllegalArgumentException if the collection with property names is <b>null</b>
* @param propertiesToSuppress the names of the properties to be suppressed (must not be <strong>null</strong>)
* @throws IllegalArgumentException if the collection with property names is <strong>null</strong>
*/
public SuppressPropertiesBeanIntrospector(final Collection<String> propertiesToSuppress) {
Objects.requireNonNull(propertiesToSuppress, "propertiesToSuppress");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
import org.apache.commons.logging.LogFactory;

/**
* Base {@link Converter} implementation that provides the structure for handling conversion <b>to</b> and <b>from</b> a specified type.
* Base {@link Converter} implementation that provides the structure for handling conversion <strong>to</strong> and <strong>from</strong> a specified type.
* <p>
* This implementation provides the basic structure for converting to/from a specified type optionally using a default value or throwing a
* {@link ConversionException} if a conversion error occurs.
Expand Down Expand Up @@ -232,7 +232,7 @@ private <T> T convertToDefaultType(final Object value) {
/**
* Converts the input object into a String.
* <p>
* <b>N.B.</b>This implementation simply uses the value's {@code toString()} method and should be overridden if a more sophisticated mechanism for
* <strong>N.B.</strong>This implementation simply uses the value's {@code toString()} method and should be overridden if a more sophisticated mechanism for
* <em>conversion to a String</em> is required.
* </p>
*
Expand Down
Loading

0 comments on commit 1231b38

Please sign in to comment.