Commit 1a87fce4 authored by OrangeDog's avatar OrangeDog Committed by Stephane Nicoll

Polish duration support javadoc

See gh-21579
parent 9cf44886
...@@ -134,7 +134,7 @@ public enum DurationStyle { ...@@ -134,7 +134,7 @@ public enum DurationStyle {
* Detect the style then parse the value to return a duration. * Detect the style then parse the value to return a duration.
* @param value the value to parse * @param value the value to parse
* @return the parsed duration * @return the parsed duration
* @throws IllegalStateException if the value is not a known style or cannot be parsed * @throws IllegalArgumentException if the value is not a known style or cannot be parsed
*/ */
public static Duration detectAndParse(String value) { public static Duration detectAndParse(String value) {
return detectAndParse(value, null); return detectAndParse(value, null);
...@@ -146,7 +146,7 @@ public enum DurationStyle { ...@@ -146,7 +146,7 @@ public enum DurationStyle {
* @param unit the duration unit to use if the value doesn't specify one ({@code null} * @param unit the duration unit to use if the value doesn't specify one ({@code null}
* will default to ms) * will default to ms)
* @return the parsed duration * @return the parsed duration
* @throws IllegalStateException if the value is not a known style or cannot be parsed * @throws IllegalArgumentException if the value is not a known style or cannot be parsed
*/ */
public static Duration detectAndParse(String value, ChronoUnit unit) { public static Duration detectAndParse(String value, ChronoUnit unit) {
return detect(value).parse(value, unit); return detect(value).parse(value, unit);
...@@ -156,7 +156,7 @@ public enum DurationStyle { ...@@ -156,7 +156,7 @@ public enum DurationStyle {
* Detect the style from the given source value. * Detect the style from the given source value.
* @param value the source value * @param value the source value
* @return the duration style * @return the duration style
* @throws IllegalStateException if the value is not a known style * @throws IllegalArgumentException if the value is not a known style
*/ */
public static DurationStyle detect(String value) { public static DurationStyle detect(String value) {
Assert.notNull(value, "Value must not be null"); Assert.notNull(value, "Value must not be null");
......
...@@ -176,7 +176,7 @@ public enum PeriodStyle { ...@@ -176,7 +176,7 @@ public enum PeriodStyle {
* Detect the style then parse the value to return a period. * Detect the style then parse the value to return a period.
* @param value the value to parse * @param value the value to parse
* @return the parsed period * @return the parsed period
* @throws IllegalStateException if the value is not a known style or cannot be parsed * @throws IllegalArgumentException if the value is not a known style or cannot be parsed
*/ */
public static Period detectAndParse(String value) { public static Period detectAndParse(String value) {
return detectAndParse(value, null); return detectAndParse(value, null);
...@@ -188,7 +188,7 @@ public enum PeriodStyle { ...@@ -188,7 +188,7 @@ public enum PeriodStyle {
* @param unit the period unit to use if the value doesn't specify one ({@code null} * @param unit the period unit to use if the value doesn't specify one ({@code null}
* will default to ms) * will default to ms)
* @return the parsed period * @return the parsed period
* @throws IllegalStateException if the value is not a known style or cannot be parsed * @throws IllegalArgumentException if the value is not a known style or cannot be parsed
*/ */
public static Period detectAndParse(String value, ChronoUnit unit) { public static Period detectAndParse(String value, ChronoUnit unit) {
return detect(value).parse(value, unit); return detect(value).parse(value, unit);
...@@ -198,7 +198,7 @@ public enum PeriodStyle { ...@@ -198,7 +198,7 @@ public enum PeriodStyle {
* Detect the style from the given source value. * Detect the style from the given source value.
* @param value the source value * @param value the source value
* @return the period style * @return the period style
* @throws IllegalStateException if the value is not a known style * @throws IllegalArgumentException if the value is not a known style
*/ */
public static PeriodStyle detect(String value) { public static PeriodStyle detect(String value) {
Assert.notNull(value, "Value must not be null"); Assert.notNull(value, "Value must not be null");
......
...@@ -32,7 +32,8 @@ import org.springframework.util.ObjectUtils; ...@@ -32,7 +32,8 @@ import org.springframework.util.ObjectUtils;
* @author Eddú Meléndez * @author Eddú Meléndez
* @author Edson Chávez * @author Edson Chávez
* @since 2.3.0 * @since 2.3.0
* @see Period * @see PeriodFormat
* @see PeriodUnit
*/ */
public class PeriodToStringConverter implements GenericConverter { public class PeriodToStringConverter implements GenericConverter {
......
...@@ -33,6 +33,7 @@ import org.springframework.util.ObjectUtils; ...@@ -33,6 +33,7 @@ import org.springframework.util.ObjectUtils;
* @author Eddú Meléndez * @author Eddú Meléndez
* @author Edson Chávez * @author Edson Chávez
* @since 2.3.0 * @since 2.3.0
* @see PeriodFormat
* @see PeriodUnit * @see PeriodUnit
*/ */
public class StringToPeriodConverter implements GenericConverter { public class StringToPeriodConverter implements GenericConverter {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment