Skip to content

Commit b74c7be

Browse files
committed
Updated documentation
1 parent da513f8 commit b74c7be

File tree

6 files changed

+55
-1
lines changed

6 files changed

+55
-1
lines changed

src/main/java/org/apache/commons/beanutils2/converters/ColorConverter.java

+10-1
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,9 @@ public ColorConverter() {
6060
}
6161

6262
/**
63+
* Constructs a {@link org.apache.commons.beanutils2.Converter} that will return
64+
* the specified default value if a conversion error occurs.
65+
*
6366
* @param defaultValue The default value to be returned
6467
* if the value to be converted is missing or an error
6568
* occurs converting the value.
@@ -68,14 +71,20 @@ public ColorConverter(final Object defaultValue) {
6871
super(defaultValue);
6972
}
7073

74+
/**
75+
* Gets the default type this {@code Converter} handles.
76+
*
77+
* @return The default type this {@code Converter} handles.
78+
* @since 2.0.0
79+
*/
7180
@Override
7281
protected Class<?> getDefaultType() {
7382
return Color.class;
7483
}
7584

7685
/**
7786
* <p>
78-
* Convert the configuration value to a Java {@link Color} object,
87+
* Converts the configuration value to a Java {@link Color} object,
7988
* by reading the hexadecimal {@link String} and converting each component.
8089
* </p>
8190
*

src/main/java/org/apache/commons/beanutils2/converters/DimensionConverter.java

+9
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,9 @@ public DimensionConverter() {
5353
}
5454

5555
/**
56+
* Constructs a {@link org.apache.commons.beanutils2.Converter} that will return
57+
* the specified default value if a conversion error occurs.
58+
*
5659
* @param defaultValue The default value to be returned
5760
* if the value to be converted is missing or an error
5861
* occurs converting the value.
@@ -61,6 +64,12 @@ public DimensionConverter(final Object defaultValue) {
6164
super(defaultValue);
6265
}
6366

67+
/**
68+
* Gets the default type this {@code Converter} handles.
69+
*
70+
* @return The default type this {@code Converter} handles.
71+
* @since 2.0.0
72+
*/
6473
@Override
6574
protected Class<?> getDefaultType() {
6675
return Dimension.class;

src/main/java/org/apache/commons/beanutils2/converters/InetAddressConverter.java

+9
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ public InetAddressConverter() {
3939
}
4040

4141
/**
42+
* Constructs a {@link org.apache.commons.beanutils2.Converter} that will return
43+
* the specified default value if a conversion error occurs.
44+
*
4245
* @param defaultValue The default value to be returned
4346
* if the value to be converted is missing or an error
4447
* occurs converting the value.
@@ -47,6 +50,12 @@ public InetAddressConverter(final Object defaultValue) {
4750
super(defaultValue);
4851
}
4952

53+
/**
54+
* Gets the default type this {@code Converter} handles.
55+
*
56+
* @return The default type this {@code Converter} handles.
57+
* @since 2.0.0
58+
*/
5059
@Override
5160
protected Class<?> getDefaultType() {
5261
return InetAddress.class;

src/main/java/org/apache/commons/beanutils2/converters/LocaleConverter.java

+9
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@ public LocaleConverter() {
3737
}
3838

3939
/**
40+
* Constructs a {@link org.apache.commons.beanutils2.Converter} that will return
41+
* the specified default value if a conversion error occurs.
42+
*
4043
* @param defaultValue The default value to be returned
4144
* if the value to be converted is missing or an error
4245
* occurs converting the value.
@@ -45,6 +48,12 @@ public LocaleConverter(final Object defaultValue) {
4548
super(defaultValue);
4649
}
4750

51+
/**
52+
* Gets the default type this {@code Converter} handles.
53+
*
54+
* @return The default type this {@code Converter} handles.
55+
* @since 2.0.0
56+
*/
4857
@Override
4958
protected Class<?> getDefaultType() {
5059
return Locale.class;

src/main/java/org/apache/commons/beanutils2/converters/PatternConverter.java

+9
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@ public PatternConverter() {
3737
}
3838

3939
/**
40+
* Constructs a {@link org.apache.commons.beanutils2.Converter} that will return
41+
* the specified default value if a conversion error occurs.
42+
*
4043
* @param defaultValue The default value to be returned
4144
* if the value to be converted is missing or an error
4245
* occurs converting the value.
@@ -45,6 +48,12 @@ public PatternConverter(final Object defaultValue) {
4548
super(defaultValue);
4649
}
4750

51+
/**
52+
* Gets the default type this {@code Converter} handles.
53+
*
54+
* @return The default type this {@code Converter} handles.
55+
* @since 2.0.0
56+
*/
4857
@Override
4958
protected Class<?> getDefaultType() {
5059
return Pattern.class;

src/main/java/org/apache/commons/beanutils2/converters/PointConverter.java

+9
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ public PointConverter() {
3939
}
4040

4141
/**
42+
* Constructs a {@link org.apache.commons.beanutils2.Converter} that will return
43+
* the specified default value if a conversion error occurs.
44+
*
4245
* @param defaultValue The default value to be returned
4346
* if the value to be converted is missing or an error
4447
* occurs converting the value.
@@ -47,6 +50,12 @@ public PointConverter(final Object defaultValue) {
4750
super(defaultValue);
4851
}
4952

53+
/**
54+
* Gets the default type this {@code Converter} handles.
55+
*
56+
* @return The default type this {@code Converter} handles.
57+
* @since 2.0.0
58+
*/
5059
@Override
5160
protected Class<?> getDefaultType() {
5261
return Point.class;

0 commit comments

Comments
 (0)