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

Polish duration support javadoc 

See gh-21579
This commit is contained in:
OrangeDog 2020-05-26 14:35:08 +01:00 committed by Stephane Nicoll
parent 9cf448863a
commit 1a87fce416
4 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -134,7 +134,7 @@ public enum DurationStyle {
* Detect the style then parse the value to return a duration.
* @param value the value to parse
* @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) {
return detectAndParse(value, null);
@ -146,7 +146,7 @@ public enum DurationStyle {
* @param unit the duration unit to use if the value doesn't specify one ({@code null}
* will default to ms)
* @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) {
return detect(value).parse(value, unit);
@ -156,7 +156,7 @@ public enum DurationStyle {
* Detect the style from the given source value.
* @param value the source value
* @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) {
Assert.notNull(value, "Value must not be null");

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

@ -176,7 +176,7 @@ public enum PeriodStyle {
* Detect the style then parse the value to return a period.
* @param value the value to parse
* @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) {
return detectAndParse(value, null);
@ -188,7 +188,7 @@ public enum PeriodStyle {
* @param unit the period unit to use if the value doesn't specify one ({@code null}
* will default to ms)
* @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) {
return detect(value).parse(value, unit);
@ -198,7 +198,7 @@ public enum PeriodStyle {
* Detect the style from the given source value.
* @param value the source value
* @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) {
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 Edson Chávez
* @since 2.3.0
* @see Period
* @see PeriodFormat
* @see PeriodUnit
*/
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 Edson Chávez
* @since 2.3.0
* @see PeriodFormat
* @see PeriodUnit
*/
public class StringToPeriodConverter implements GenericConverter {