diff options
author | elmot <elmotelmot.vaadin.com> | 2017-07-31 18:52:07 +0300 |
---|---|---|
committer | elmot <elmotelmot.vaadin.com> | 2017-07-31 18:52:07 +0300 |
commit | febba0418e38d4a0e90451ca19b8a5d6d3e674c7 (patch) | |
tree | 8f607d0a347dafabd433b995ce6c1d9e8759dac8 | |
parent | 63b5f11988e249270e9bec8477f5fe88403a4c7f (diff) | |
download | vaadin-framework-febba0418e38d4a0e90451ca19b8a5d6d3e674c7.tar.gz vaadin-framework-febba0418e38d4a0e90451ca19b8a5d6d3e674c7.zip |
Formatting fix
-rw-r--r-- | server/src/main/java/com/vaadin/ui/AbstractDateField.java | 101 |
1 files changed, 65 insertions, 36 deletions
diff --git a/server/src/main/java/com/vaadin/ui/AbstractDateField.java b/server/src/main/java/com/vaadin/ui/AbstractDateField.java index f70246f2c6..e35840b62f 100644 --- a/server/src/main/java/com/vaadin/ui/AbstractDateField.java +++ b/server/src/main/java/com/vaadin/ui/AbstractDateField.java @@ -60,10 +60,15 @@ import com.vaadin.ui.declarative.DesignContext; /** * A date editor component with {@link LocalDate} as an input value. * - * @param <T> type of date ({@code LocalDate} or {@code LocalDateTime}). - * @param <R> resolution enumeration type * @author Vaadin Ltd + * * @since 8.0 + * + * @param <T> + * type of date ({@code LocalDate} or {@code LocalDateTime}). + * @param <R> + * resolution enumeration type + * */ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster & Serializable & Comparable<? super T>, R extends Enum<R>> extends AbstractField<T> @@ -111,7 +116,8 @@ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster & * Constructs an empty <code>AbstractDateField</code> with no caption and * specified {@code resolution}. * - * @param resolution initial resolution for the field + * @param resolution + * initial resolution for the field */ public AbstractDateField(R resolution) { this.resolution = resolution; @@ -120,8 +126,10 @@ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster & /** * Constructs an empty <code>AbstractDateField</code> with caption. * - * @param caption the caption of the datefield. - * @param resolution initial resolution for the field + * @param caption + * the caption of the datefield. + * @param resolution + * initial resolution for the field */ public AbstractDateField(String caption, R resolution) { this(resolution); @@ -132,9 +140,12 @@ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster & * Constructs a new <code>AbstractDateField</code> with the given caption * and initial text contents. * - * @param caption the caption <code>String</code> for the editor. - * @param value the date/time value. - * @param resolution initial resolution for the field + * @param caption + * the caption <code>String</code> for the editor. + * @param value + * the date/time value. + * @param resolution + * initial resolution for the field */ public AbstractDateField(String caption, T value, R resolution) { this(caption, resolution); @@ -275,7 +286,8 @@ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster & * validate. If <code>startDate</code> is set to <code>null</code>, any * value before <code>endDate</code> will be accepted by the range * - * @param startDate - the allowed range's start date + * @param startDate + * - the allowed range's start date */ public void setRangeStart(T startDate) { Date date = convertToDate(startDate); @@ -291,8 +303,9 @@ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster & /** * Sets the current error message if the range validation fails. * - * @param dateOutOfRangeMessage - Localizable message which is shown when value (the date) is - * set outside allowed range + * @param dateOutOfRangeMessage + * - Localizable message which is shown when value (the date) is + * set outside allowed range */ public void setDateOutOfRangeMessage(String dateOutOfRangeMessage) { this.dateOutOfRangeMessage = dateOutOfRangeMessage; @@ -301,8 +314,8 @@ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster & /** * Returns current date-out-of-range error message. * - * @return Current error message for dates out of range. * @see #setDateOutOfRangeMessage(String) + * @return Current error message for dates out of range. */ public String getDateOutOfRangeMessage() { return dateOutOfRangeMessage; @@ -319,10 +332,11 @@ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster & /** * Sets the resolution of the DateField. - * <p> + * * The default resolution is {@link DateResolution#DAY} since Vaadin 7.0. * - * @param resolution the resolution to set, not {@code null} + * @param resolution + * the resolution to set, not {@code null} */ public void setResolution(R resolution) { this.resolution = resolution; @@ -335,8 +349,9 @@ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster & * validate. If <code>endDate</code> is set to <code>null</code>, any value * after <code>startDate</code> will be accepted by the range. * - * @param endDate - the allowed range's end date (inclusive, based on the - * current resolution) + * @param endDate + * - the allowed range's end date (inclusive, based on the + * current resolution) */ public void setRangeEnd(T endDate) { Date date = convertToDate(endDate); @@ -370,12 +385,14 @@ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster & /** * Sets formatting used by some component implementations. See * {@link SimpleDateFormat} for format details. - * <p> + * * By default it is encouraged to used default formatting defined by Locale, * but due some JVM bugs it is sometimes necessary to use this method to * override formatting. See Vaadin issue #2200. * - * @param dateFormat the dateFormat to set + * @param dateFormat + * the dateFormat to set + * * @see com.vaadin.ui.AbstractComponent#setLocale(Locale)) */ public void setDateFormat(String dateFormat) { @@ -397,10 +414,12 @@ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster & * Specifies whether or not date/time interpretation in component is to be * lenient. * - * @param lenient true if the lenient mode is to be turned on; false if it is to - * be turned off. * @see Calendar#setLenient(boolean) * @see #isLenient() + * + * @param lenient + * true if the lenient mode is to be turned on; false if it is to + * be turned off. */ public void setLenient(boolean lenient) { this.lenient = lenient; @@ -410,9 +429,10 @@ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster & /** * Returns whether date/time interpretation is to be lenient. * - * @return true if the interpretation mode of this calendar is lenient; - * false otherwise. * @see #setLenient(boolean) + * + * @return true if the interpretation mode of this calendar is lenient; + * false otherwise. */ public boolean isLenient() { return lenient; @@ -427,7 +447,8 @@ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster & * Sets the value of this object. If the new value is not equal to * {@code getValue()}, fires a {@link ValueChangeEvent} . * - * @param value the new value, may be {@code null} + * @param value + * the new value, may be {@code null} */ @Override public void setValue(T value) { @@ -464,7 +485,8 @@ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster & * 8601 defines that a week always starts with a Monday so the week numbers * are only shown if this is the case. * - * @param showWeekNumbers true if week numbers should be shown, false otherwise. + * @param showWeekNumbers + * true if week numbers should be shown, false otherwise. */ public void setShowISOWeekNumbers(boolean showWeekNumbers) { showISOWeekNumbers = showWeekNumbers; @@ -479,9 +501,10 @@ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster & * {@link Exception#getLocalizedMessage()} will be used instead of the value * returned by this method. * - * @return the error message that the DateField uses when it can't parse the - * textual input from user to a Date object * @see #setParseErrorMessage(String) + * + * @return the error message that the DateField uses when it can't parse the + * textual input from user to a Date object */ public String getParseErrorMessage() { return defaultParseErrorMessage; @@ -493,9 +516,9 @@ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster & * {@link #handleUnparsableDateString(String)} method is overridden, the * localized message from its exception is used. * - * @param parsingErrorMessage * @see #getParseErrorMessage() * @see #handleUnparsableDateString(String) + * @param parsingErrorMessage */ public void setParseErrorMessage(String parsingErrorMessage) { defaultParseErrorMessage = parsingErrorMessage; @@ -559,15 +582,16 @@ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster & /** * This method is called to handle a non-empty date string from the client * if the client could not parse it as a Date. - * <p> + * * By default, an error result is returned whose error message is * {@link #getParseErrorMessage()}. - * <p> + * * This can be overridden to handle conversions, to return a result with * {@code null} value (equivalent to empty input) or to return a custom * error. * - * @param dateString date string to handle + * @param dateString + * date string to handle * @return result that contains parsed Date as a value or an error */ protected Result<T> handleUnparsableDateString(String dateString) { @@ -613,8 +637,10 @@ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster & * Returns a date integer value part for the given {@code date} for the * given {@code resolution}. * - * @param date the given date - * @param resolution the resolution to extract a value from the date by + * @param date + * the given date + * @param resolution + * the resolution to extract a value from the date by * @return the integer value part of the date by the given resolution */ protected abstract int getDatePart(T date, R resolution); @@ -625,7 +651,8 @@ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster & * <p> * This is the opposite to {@link #getDatePart(Temporal, Enum)}. * - * @param resolutionValues date values to construct a date + * @param resolutionValues + * date values to construct a date * @return date built from the given map of date values */ protected abstract T buildDate(Map<R, Integer> resolutionValues); @@ -641,7 +668,8 @@ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster & /** * Converts {@link Date} to date type {@code T}. * - * @param date a date to convert + * @param date + * a date to convert * @return object of type {@code T} representing the {@code date} */ protected abstract T convertFromDate(Date date); @@ -651,7 +679,8 @@ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster & * <p> * This is the opposite to {@link #convertFromDate(Date)}. * - * @param date the date of type {@code T} + * @param date + * the date of type {@code T} * @return converted date of type {@code Date} */ protected abstract Date convertToDate(T date); @@ -671,7 +700,7 @@ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster & } else { throw new RuntimeException("Cannot detect resoluton type " + Optional.ofNullable(resolutionType).map(Type::getTypeName) - .orElse(null)); + .orElse(null)); } } |