root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 15 Packages Projects Releases Wiki Activity

Merge pull request #21579 from OrangeDog 

* pr/21579:
  Polish "Polish duration support javadoc"
  Polish duration support javadoc

Closes gh-21579
This commit is contained in:
Stephane Nicoll 2020-05-26 18:26:04 +02:00
parent 9cf448863a b21c09020d
commit 1975cf498c
4 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/convert/DurationStyle.java
View File

@ -134,7 +134,8 @@ 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 +147,8 @@ 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 +158,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");

8
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/convert/PeriodStyle.java
View File

@ -176,7 +176,8 @@ 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 +189,8 @@ 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 +200,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");

3
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/convert/PeriodToStringConverter.java
View File

@ -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 {

1
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/convert/StringToPeriodConverter.java
View File

@ -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 {