Skip to content

Commit f04d0a8

Browse files
committed
Use Javadoc instead of HTML tag
1 parent eeaadc2 commit f04d0a8

File tree

111 files changed

+1518
-1518
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

111 files changed

+1518
-1518
lines changed

src/main/java/org/apache/commons/beanutils/BaseDynaBeanMapDecorator.java

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
import java.util.Set;
2626

2727
/**
28-
* <p>A base class for decorators providing <code>Map</code> behavior on
28+
* <p>A base class for decorators providing {@code Map} behavior on
2929
* {@link DynaBean}s.</p>
3030
*
3131
* <p>The motivation for this implementation is to provide access to {@link DynaBean}
@@ -107,8 +107,8 @@ public BaseDynaBeanMapDecorator(final DynaBean dynaBean) {
107107
* Construct a Map for the specified {@link DynaBean}.
108108
*
109109
* @param dynaBean The dyna bean being decorated
110-
* @param readOnly <code>true</code> if the Map is read only
111-
* otherwise <code>false</code>
110+
* @param readOnly {@code true} if the Map is read only
111+
* otherwise {@code false}
112112
* @throws IllegalArgumentException if the {@link DynaBean} is null.
113113
*/
114114
public BaseDynaBeanMapDecorator(final DynaBean dynaBean, final boolean readOnly) {
@@ -134,7 +134,7 @@ public void clear() {
134134
* value for one (or more) of its properties.
135135
*
136136
* @param key The {@link DynaBean}'s property name
137-
* @return <code>true</code> if one of the {@link DynaBean}'s
137+
* @return {@code true} if one of the {@link DynaBean}'s
138138
* properties contains a specified value.
139139
*/
140140
@Override
@@ -149,9 +149,9 @@ public boolean containsKey(final Object key) {
149149
* a specified value.
150150
*
151151
* @param value The value to check for.
152-
* @return <code>true</code> if one of the the {@link DynaBean}'s
152+
* @return {@code true} if one of the the {@link DynaBean}'s
153153
* properties contains the specified value, otherwise
154-
* <code>false</code>.
154+
* {@code false}.
155155
*/
156156
@Override
157157
public boolean containsValue(final Object value) {
@@ -182,7 +182,7 @@ public boolean containsValue(final Object value) {
182182
* <p>Returns the Set of the property/value mappings
183183
* in the decorated {@link DynaBean}.</p>
184184
*
185-
* <p>Each element in the Set is a <code>Map.Entry</code>
185+
* <p>Each element in the Set is a {@code Map.Entry}
186186
* type.</p>
187187
*
188188
* @return An unmodifiable set of the DynaBean
@@ -236,8 +236,8 @@ private DynaProperty[] getDynaProperties() {
236236
* Indicate whether the decorated {@link DynaBean} has
237237
* any properties.
238238
*
239-
* @return <code>true</code> if the {@link DynaBean} has
240-
* no properties, otherwise <code>false</code>.
239+
* @return {@code true} if the {@link DynaBean} has
240+
* no properties, otherwise {@code false}.
241241
*/
242242
@Override
243243
public boolean isEmpty() {
@@ -247,8 +247,8 @@ public boolean isEmpty() {
247247
/**
248248
* Indicate whether the Map is read only.
249249
*
250-
* @return <code>true</code> if the Map is read only,
251-
* otherwise <code>false</code>.
250+
* @return {@code true} if the Map is read only,
251+
* otherwise {@code false}.
252252
*/
253253
public boolean isReadOnly() {
254254
return readOnly;
@@ -297,7 +297,7 @@ public Set<K> keySet() {
297297
* @param value The value for the specified property.
298298
* @return The previous property's value.
299299
* @throws UnsupportedOperationException if
300-
* <code>isReadOnly()</code> is true.
300+
* {@code isReadOnly()} is true.
301301
*/
302302
@Override
303303
public Object put(final K key, final Object value) {
@@ -315,7 +315,7 @@ public Object put(final K key, final Object value) {
315315
*
316316
* @param map The Map of values to copy.
317317
* @throws UnsupportedOperationException if
318-
* <code>isReadOnly()</code> is true.
318+
* {@code isReadOnly()} is true.
319319
*/
320320
@Override
321321
public void putAll(final Map<? extends K, ? extends Object> map) {

src/main/java/org/apache/commons/beanutils/BasicDynaBean.java

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@
2525
import java.util.Objects;
2626

2727
/**
28-
* <p>Minimal implementation of the <code>DynaBean</code> interface. Can be
28+
* <p>Minimal implementation of the {@code DynaBean} interface. Can be
2929
* used as a convenience base class for more sophisticated implementations.</p>
3030
*
3131
* <p><strong>IMPLEMENTATION NOTE</strong> - Instances of this class that are
3232
* accessed from multiple threads simultaneously need to be synchronized.</p>
3333
*
3434
* <p><strong>IMPLEMENTATION NOTE</strong> - Instances of this class can be
3535
* successfully serialized and deserialized <strong>ONLY</strong> if all
36-
* property values are <code>Serializable</code>.</p>
36+
* property values are {@code Serializable}.</p>
3737
*
3838
*/
3939

@@ -42,7 +42,7 @@ public class BasicDynaBean implements DynaBean, Serializable {
4242
private static final long serialVersionUID = 1L;
4343

4444
/**
45-
* The <code>DynaClass</code> "base class" that this DynaBean
45+
* The {@code DynaClass} "base class" that this DynaBean
4646
* is associated with.
4747
*/
4848
protected DynaClass dynaClass;
@@ -56,8 +56,8 @@ public class BasicDynaBean implements DynaBean, Serializable {
5656
private transient Map<String, Object> mapDecorator;
5757

5858
/**
59-
* Construct a new <code>DynaBean</code> associated with the specified
60-
* <code>DynaClass</code> instance.
59+
* Construct a new {@code DynaBean} associated with the specified
60+
* {@code DynaClass} instance.
6161
*
6262
* @param dynaClass The DynaClass we are associated with
6363
*/
@@ -73,8 +73,8 @@ public BasicDynaBean(final DynaClass dynaClass) {
7373
*
7474
* @param name Name of the property to check
7575
* @param key Name of the key to check
76-
* @return <code>true</code> if the mapped property contains a value for
77-
* the specified key, otherwise <code>false</code>
76+
* @return {@code true} if the mapped property contains a value for
77+
* the specified key, otherwise {@code false}
7878
*
7979
* @throws IllegalArgumentException if there is no property
8080
* of the specified name
@@ -170,7 +170,7 @@ public Object get(final String name, final int index) {
170170

171171
/**
172172
* Return the value of a mapped property with the specified name,
173-
* or <code>null</code> if there is no value for the specified key.
173+
* or {@code null} if there is no value for the specified key.
174174
*
175175
* @param name Name of the property whose value is to be retrieved
176176
* @param key Key of the value to be retrieved
@@ -191,7 +191,7 @@ public Object get(final String name, final String key) {
191191
}
192192

193193
/**
194-
* Return the <code>DynaClass</code> instance that describes the set of
194+
* Return the {@code DynaClass} instance that describes the set of
195195
* properties available for this DynaBean.
196196
*
197197
* @return The associated DynaClass
@@ -226,9 +226,9 @@ protected DynaProperty getDynaProperty(final String name) {
226226
* Return a Map representation of this DynaBean.
227227
* <p>
228228
* This, for example, could be used in JSTL in the following way to access
229-
* a DynaBean's <code>fooProperty</code>:
229+
* a DynaBean's {@code fooProperty}:
230230
* </p>
231-
* <ul><li><code>${myDynaBean.<strong>map</strong>.fooProperty}</code></li></ul>
231+
* <ul><li>{@code ${myDynaBean.<strong>map</strong>.fooProperty}}</li></ul>
232232
*
233233
* @return a Map representation of this DynaBean
234234
* @since 1.8.0
@@ -248,8 +248,8 @@ public Map<String, Object> getMap() {
248248
*
249249
* @param dest Destination class
250250
* @param source Source class
251-
* @return <code>true</code> if the source class is assignable to the
252-
* destination class, otherwise <code>false</code>
251+
* @return {@code true} if the source class is assignable to the
252+
* destination class, otherwise {@code false}
253253
*/
254254
protected boolean isAssignable(final Class<?> dest, final Class<?> source) {
255255

src/main/java/org/apache/commons/beanutils/BasicDynaClass.java

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@
2323
import java.util.HashMap;
2424

2525
/**
26-
* <p>Minimal implementation of the <code>DynaClass</code> interface. Can be
26+
* <p>Minimal implementation of the {@code DynaClass} interface. Can be
2727
* used as a convenience base class for more sophisticated implementations.</p> *
28-
* <p><strong>IMPLEMENTATION NOTE</strong> - The <code>DynaBean</code>
28+
* <p><strong>IMPLEMENTATION NOTE</strong> - The {@code DynaBean}
2929
* implementation class supplied to our constructor MUST have a one-argument
30-
* constructor of its own that accepts a <code>DynaClass</code>. This is
30+
* constructor of its own that accepts a {@code DynaClass}. This is
3131
* used to associate the DynaBean instance with this DynaClass.</p>
3232
*
3333
*/
@@ -42,7 +42,7 @@ public class BasicDynaClass implements DynaClass, Serializable {
4242
protected static Class<?>[] constructorTypes = { DynaClass.class };
4343

4444
/**
45-
* The constructor of the <code>dynaBeanClass</code> that we will use
45+
* The constructor of the {@code dynaBeanClass} that we will use
4646
* for creating new instances.
4747
*/
4848
protected transient Constructor<?> constructor;
@@ -54,7 +54,7 @@ public class BasicDynaClass implements DynaClass, Serializable {
5454
protected Object[] constructorValues = { this };
5555

5656
/**
57-
* The <code>DynaBean</code> implementation class we will use for
57+
* The {@code DynaBean} implementation class we will use for
5858
* creating new instances.
5959
*/
6060
protected Class<?> dynaBeanClass = BasicDynaBean.class;
@@ -72,7 +72,7 @@ public class BasicDynaClass implements DynaClass, Serializable {
7272
/**
7373
* The set of dynamic properties that are part of this DynaClass,
7474
* keyed by the property name. Individual descriptor instances will
75-
* be the same instances as those in the <code>properties</code> list.
75+
* be the same instances as those in the {@code properties} list.
7676
*/
7777
protected HashMap<String, DynaProperty> propertiesMap = new HashMap<>();
7878

@@ -116,8 +116,8 @@ public BasicDynaClass(final String name, Class<?> dynaBeanClass,
116116

117117
/**
118118
* Return the Class object we will use to create new instances in the
119-
* <code>newInstance()</code> method. This Class <strong>MUST</strong>
120-
* implement the <code>DynaBean</code> interface.
119+
* {@code newInstance()} method. This Class <strong>MUST</strong>
120+
* implement the {@code DynaBean} interface.
121121
*
122122
* @return The class of the {@link DynaBean}
123123
*/
@@ -126,12 +126,12 @@ public Class<?> getDynaBeanClass() {
126126
}
127127

128128
/**
129-
* <p>Return an array of <code>ProperyDescriptors</code> for the properties
129+
* <p>Return an array of {@code ProperyDescriptors} for the properties
130130
* currently defined in this DynaClass. If no properties are defined, a
131131
* zero-length array will be returned.</p>
132132
*
133133
* <p><strong>FIXME</strong> - Should we really be implementing
134-
* <code>getBeanInfo()</code> instead, which returns property descriptors
134+
* {@code getBeanInfo()} instead, which returns property descriptors
135135
* and a bunch of other stuff?</p>
136136
*
137137
* @return the set of properties for this DynaClass
@@ -143,7 +143,7 @@ public DynaProperty[] getDynaProperties() {
143143

144144
/**
145145
* Return a property descriptor for the specified property, if it exists;
146-
* otherwise, return <code>null</code>.
146+
* otherwise, return {@code null}.
147147
*
148148
* @param name Name of the dynamic property for which a descriptor
149149
* is requested
@@ -161,8 +161,8 @@ public DynaProperty getDynaProperty(final String name) {
161161

162162
/**
163163
* Return the name of this DynaClass (analogous to the
164-
* <code>getName()</code> method of <code>java.lang.Class</code>), which
165-
* allows the same <code>DynaClass</code> implementation class to support
164+
* {@code getName()} method of {@code java.lang.Class}), which
165+
* allows the same {@code DynaClass} implementation class to support
166166
* different dynamic classes, with different sets of properties.
167167
*
168168
* @return the name of the DynaClass
@@ -176,7 +176,7 @@ public String getName() {
176176
* Instantiate and return a new DynaBean instance, associated
177177
* with this DynaClass.
178178
*
179-
* @return A new <code>DynaBean</code> instance
179+
* @return A new {@code DynaBean} instance
180180
* @throws IllegalAccessException if the Class or the appropriate
181181
* constructor is not accessible
182182
* @throws InstantiationException if this Class represents an abstract
@@ -201,12 +201,12 @@ public DynaBean newInstance()
201201

202202
/**
203203
* Set the Class object we will use to create new instances in the
204-
* <code>newInstance()</code> method. This Class <strong>MUST</strong>
205-
* implement the <code>DynaBean</code> interface.
204+
* {@code newInstance()} method. This Class <strong>MUST</strong>
205+
* implement the {@code DynaBean} interface.
206206
*
207207
* @param dynaBeanClass The new Class object
208208
* @throws IllegalArgumentException if the specified Class does not
209-
* implement the <code>DynaBean</code> interface
209+
* implement the {@code DynaBean} interface
210210
*/
211211
protected void setDynaBeanClass(final Class<?> dynaBeanClass) {
212212
// Validate the argument type specified

src/main/java/org/apache/commons/beanutils/BeanAccessLanguageException.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ public class BeanAccessLanguageException extends IllegalArgumentException {
3030
private static final long serialVersionUID = 1L;
3131

3232
/**
33-
* Constructs a <code>BeanAccessLanguageException</code> without a detail message.
33+
* Constructs a {@code BeanAccessLanguageException} without a detail message.
3434
*/
3535
public BeanAccessLanguageException() {
3636
}
3737

3838
/**
39-
* Constructs a <code>BeanAccessLanguageException</code> without a detail message.
39+
* Constructs a {@code BeanAccessLanguageException} without a detail message.
4040
*
4141
* @param message the detail message explaining this exception
4242
*/

src/main/java/org/apache/commons/beanutils/BeanComparator.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@
3333
* <strong>Note:</strong> The BeanComparator passes the values of the specified
3434
* bean property to a ComparableComparator, if no comparator is
3535
* specified in the constructor. If you are comparing two beans based
36-
* on a property that could contain "null" values, a suitable <code>Comparator</code>
37-
* or <code>ComparatorChain</code> should be supplied in the constructor.
36+
* on a property that could contain "null" values, a suitable {@code Comparator}
37+
* or {@code ComparatorChain} should be supplied in the constructor.
3838
* Note that the passed in {@code Comparator} must be able to handle the
3939
* passed in objects. Because the type of the property to be compared is not
4040
* known at compile time no type checks can be performed by the compiler.
@@ -77,13 +77,13 @@ public BeanComparator() {
7777
* <p>Constructs a property-based comparator for beans.
7878
* This compares two beans by the property
7979
* specified in the property parameter. This constructor creates
80-
* a <code>BeanComparator</code> that uses a <code>ComparableComparator</code>
80+
* a {@code BeanComparator} that uses a {@code ComparableComparator}
8181
* to compare the property values.
8282
* </p>
8383
*
8484
* <p>Passing "null" to this constructor will cause the BeanComparator
8585
* to compare objects based on natural order, that is
86-
* <code>java.lang.Comparable</code>.
86+
* {@code java.lang.Comparable}.
8787
* </p>
8888
*
8989
* @param property String Name of a bean property, which may contain the
@@ -144,7 +144,7 @@ public int compare(final T o1, final T o2) {
144144
}
145145

146146
/**
147-
* Two <code>BeanComparator</code>'s are equals if and only if
147+
* Two {@code BeanComparator}'s are equals if and only if
148148
* the wrapped comparators and the property names to be compared
149149
* are equal.
150150
* @param o Comparator to compare to

src/main/java/org/apache/commons/beanutils/BeanIntrospector.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
* Before {@link PropertyUtils} can be used for interaction with a specific Java
2828
* class, the class's properties have to be determined. This is called
2929
* <em>introspection</em> and is initiated automatically on demand.
30-
* <code>PropertyUtils</code> does not perform introspection on its own, but
30+
* {@code PropertyUtils} does not perform introspection on its own, but
3131
* delegates this task to one or more objects implementing this interface. This
3232
* makes it possible to customize introspection which may be useful for certain
3333
* code bases using non-standard conventions for accessing properties.
@@ -38,7 +38,7 @@
3838
public interface BeanIntrospector {
3939
/**
4040
* Performs introspection on a Java class. The current class to be inspected
41-
* can be queried from the passed in <code>IntrospectionContext</code>
41+
* can be queried from the passed in {@code IntrospectionContext}
4242
* object. A typical implementation has to obtain this class, determine its
4343
* properties according to the rules it implements, and add them to the
4444
* passed in context object.

0 commit comments

Comments
 (0)