Skip to content

Commit

Permalink
Update since tags in JavaDoc (#10325)
Browse files Browse the repository at this point in the history
  • Loading branch information
tsuoanttila authored Nov 15, 2017
1 parent 7a8ff50 commit ed57efc
Show file tree
Hide file tree
Showing 23 changed files with 43 additions and 43 deletions.
2 changes: 1 addition & 1 deletion client/src/main/java/com/vaadin/client/UIDL.java
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ public Iterator<Object> getChildIterator() {
* </p>
*
* @return an iterator for iterating over UIDL children
* @since
* @since 8.2
*/
@Override
public Iterator<Object> iterator() {
Expand Down
2 changes: 1 addition & 1 deletion client/src/main/java/com/vaadin/client/WidgetUtil.java
Original file line number Diff line number Diff line change
Expand Up @@ -1859,7 +1859,7 @@ public static int getRelativeY(Element element, NativeEvent event) {
* @param obj
* the object of which the type is examined
* @return {@code true} if the object is a string; {@code false} if not
* @since
* @since 8.2
*/
public static native boolean isString(Object obj)
/*-{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ public void onChange(ChangeEvent event) {
* Updates the {@link VDateField#bufferedResolutions bufferedResolutions},
* then {@link #sendBufferedValues() sends} the values to the server.
*
* @since
* @since 8.2
*/
protected final void updateAndSendBufferedValues() {
updateBufferedResolutions();
Expand All @@ -282,7 +282,7 @@ protected final void updateAndSendBufferedValues() {
* Note that this method should not send the buffered values, but use
* {@link #updateAndSendBufferedValues()} instead
*
* @since
* @since 8.2
*/
protected void updateBufferedResolutions() {
Date currentDate = getDate();
Expand Down
8 changes: 4 additions & 4 deletions client/src/main/java/com/vaadin/client/ui/VDateField.java
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ public abstract class VDateField<R extends Enum<R>> extends FlowPanel
/**
* The RPC send calls to the server.
*
* @since
* @since 8.2
*/
public AbstractDateFieldServerRpc rpc;

Expand All @@ -72,15 +72,15 @@ public abstract class VDateField<R extends Enum<R>> extends FlowPanel
*
* The value can be {@code null}.
*
* @since
* @since 8.2
*/
protected Map<R, Integer> bufferedResolutions = new HashMap<>();

/**
* A temporary holder of the date string, which would be sent to the server
* through {@link #sendBufferedValues()}.
*
* @since
* @since 8.2
*/
protected String bufferedDateString;

Expand Down Expand Up @@ -266,7 +266,7 @@ public String getResolutionVariable(R resolution) {
* Sends the {@link #bufferedDateString} and {@link #bufferedResolutions} to
* the server, and clears their values.
*
* @since
* @since 8.2
*/
public void sendBufferedValues() {
rpc.update(bufferedDateString,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ private Map<R, Integer> getTimeValues() {
* from Resolution to the corresponding value.
*
* @return default date component map
* @since
* @since 8.2
*/
protected Map<R, Integer> getDefaultValues() {
VDateField<R> widget = getWidget();
Expand Down
8 changes: 4 additions & 4 deletions client/src/main/java/com/vaadin/client/widgets/Escalator.java
Original file line number Diff line number Diff line change
Expand Up @@ -1197,7 +1197,7 @@ public void updateAriaRowCount() {
* @param element element that should get the role attribute
* @param role role to be added
*
* @since
* @since 8.2
*/
public void updateRole(final Element element, AriaGridRole role) {
element.setAttribute("role", role.getName());
Expand All @@ -1207,7 +1207,7 @@ public void updateRole(final Element element, AriaGridRole role) {
/**
* Holds the currently used aria roles within the grid for rows and cells.
*
* @since
* @since 8.2
*/
public enum AriaGridRole {

Expand Down Expand Up @@ -1290,7 +1290,7 @@ public TableSectionElement getElement() {
*
* @return the role attribute for the element to represent cells
*
* @since
* @since 8.2
*/
protected AriaGridRole getCellElementRole() {
return AriaGridRole.GRIDCELL;
Expand All @@ -1304,7 +1304,7 @@ protected AriaGridRole getCellElementRole() {
*
* @return the role attribute for the element to represent rows
*
* @since
* @since 8.2
*/
protected AriaGridRole getRowElementRole() {
return AriaGridRole.ROW;
Expand Down
4 changes: 2 additions & 2 deletions client/src/main/java/com/vaadin/client/widgets/Grid.java
Original file line number Diff line number Diff line change
Expand Up @@ -4840,7 +4840,7 @@ public String getHeaderCaption() {
* The header aria-label for this column
* @return the column itself
*
* @since
* @since 8.2
*/
public Column<C, T> setAssistiveCaption(String caption) {
if (!Objects.equals(this.assistiveCaption, caption)) {
Expand All @@ -4857,7 +4857,7 @@ public Column<C, T> setAssistiveCaption(String caption) {
*
* @return the header aria-label string
*
* @since
* @since 8.2
*/
public String getAssistiveCaption() {
return assistiveCaption;
Expand Down
10 changes: 5 additions & 5 deletions server/src/main/java/com/vaadin/data/BeanPropertySet.java
Original file line number Diff line number Diff line change
Expand Up @@ -219,14 +219,14 @@ public static class NestedBeanPropertyDefinition<T, V>
/**
* Default maximum depth for scanning nested properties.
*
* @since
* @since 8.2
*/
protected static final int MAX_PROPERTY_NESTING_DEPTH = 10;

/**
* Class containing the constraints for filtering nested properties.
*
* @since
* @since 8.2
*
*/
protected static class PropertyFilterDefinition
Expand Down Expand Up @@ -304,7 +304,7 @@ public NestedBeanPropertyDefinition(BeanPropertySet<T> propertySet,
* use format grandparent.parent.property for name if
* {@code true}, needed when creating nested definitions
* recursively like in findNestedDefinitions
* @since
* @since 8.2
*/
public NestedBeanPropertyDefinition(BeanPropertySet<T> propertySet,
PropertyDefinition<T, ?> parent, PropertyDescriptor descriptor,
Expand Down Expand Up @@ -373,7 +373,7 @@ public String getName() {
/**
* Key for identifying cached BeanPropertySet instances.
*
* @since
* @since 8.2
*/
private static class InstanceKey implements Serializable {
private Class<?> type;
Expand Down Expand Up @@ -549,7 +549,7 @@ public static <T> PropertySet<T> get(Class<? extends T> beanType) {
* @param filterDefinition
* filtering conditions for nested properties
* @return the bean property set, not <code>null</code>
* @since
* @since 8.2
*/
@SuppressWarnings("unchecked")
public static <T> PropertySet<T> get(Class<? extends T> beanType,
Expand Down
2 changes: 1 addition & 1 deletion server/src/main/java/com/vaadin/data/Binder.java
Original file line number Diff line number Diff line change
Expand Up @@ -1277,7 +1277,7 @@ public Binder(Class<BEAN> beanType) {
* the bean type to use, not {@code null}
* @param scanNestedDefinitions
* if {@code true}, scan for nested property definitions as well
* @since
* @since 8.2
*/
public Binder(Class<BEAN> beanType, boolean scanNestedDefinitions) {
this(BeanPropertySet.get(beanType, scanNestedDefinitions,
Expand Down
2 changes: 1 addition & 1 deletion server/src/main/java/com/vaadin/event/EventRouter.java
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ public Registration addListener(Class<?> eventType, Object object,
* unless {@code method} has exactly one match in {@code target}
* @throws NullPointerException
* if {@code target} is {@code null}
* @since
* @since 8.2
*/
public Registration addListener(Class<?> eventType, Object target,
Method method, String eventIdentifier, SharedState state) {
Expand Down
2 changes: 1 addition & 1 deletion server/src/main/java/com/vaadin/ui/AbstractDateField.java
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ public void beforeClientResponse(boolean initial) {
* defined in the specified {@code resolutions}
*
* @return the date object built from the specified resolutions
* @since
* @since 8.2
*/
protected T reconstructDateFromFields(Map<String, Integer> resolutions,
T oldDate) {
Expand Down
4 changes: 2 additions & 2 deletions server/src/main/java/com/vaadin/ui/Grid.java
Original file line number Diff line number Diff line change
Expand Up @@ -1212,7 +1212,7 @@ public boolean isSortable() {
*
* @return this column
*
* @since
* @since 8.2
*/
public Column<T, V> setAssistiveCaption(String caption) {
if (Objects.equals(caption, getAssistiveCaption())) {
Expand All @@ -1227,7 +1227,7 @@ public Column<T, V> setAssistiveCaption(String caption) {
*
* @return header caption
*
* @since
* @since 8.2
*/
public String getAssistiveCaption() {
return getState(false).assistiveCaption;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
* grid.
*
* @author Vaadin Ltd
* @since
* @since 8.2
* @see GridDragger
* @param <T>
* the bean type
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ public GridDragSource(Grid<T> target) {
* Gets the grid this extension has been attached to.
*
* @return the grid for this extension
* @since
* @since 8.2
*/
public Grid<T> getGrid() {
return getParent();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
* @param <T>
* The Grid bean type.
* @author Vaadin Ltd
* @since
* @since 8.2
*/
public class GridDragger<T> implements Serializable {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public GridDropTarget(Grid<T> target, DropMode dropMode) {
* Gets the grid this extension has been attached to.
*
* @return the grid for this extension
* @since
* @since 8.2
*/
public Grid<T> getGrid() {
return getParent();
Expand Down Expand Up @@ -144,7 +144,7 @@ public DropMode getDropMode() {
* @param dropAllowedOnSortedGridRows
* {@code true} for allowing, {@code false} for not allowing
* drops on sorted grid rows
* @since
* @since 8.2
*/
public void setDropAllowedOnSortedGridRows(
boolean dropAllowedOnSortedGridRows) {
Expand Down Expand Up @@ -191,7 +191,7 @@ private void updateDropModeForSortedGrid(boolean sorted) {
*
* @return whether drop are allowed for the grid's rows when user has sorted
* the grid
* @since
* @since 8.2
*/
public boolean isDropAllowedOnSortedGridRows() {
return dropAllowedOnSortedGridRows;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
* drop.
*
* @author Vaadin Ltd
* @since
* @since 8.2
*
* @param <T>
* the bean type
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
* drop.
*
* @author Vaadin Ltd
* @since
* @since 8.2
*
* @param <T>
* the bean type
Expand Down
2 changes: 1 addition & 1 deletion server/src/main/java/com/vaadin/util/ReflectTools.java
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,7 @@ private static void checkClassAccessibility(Class<?> cls) {
* @return the first non-synthetic method
* @throws IllegalStateException
* if the specified class does not have found method
* @since
* @since 8.2
*/
public static Method getMethod(Class<?> listenerClass) {
for (Method m : listenerClass.getDeclaredMethods()) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public class SharedState implements Serializable {
* A Map of event identifiers with registered listeners, {@code key} is
* event identifier, {@code value} is the listeners count.
*
* @since
* @since 8.2
*/
@NoLayout
public Map<String, Integer> registeredEventListeners;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
/**
* RPC interface for calls from client to server.
*
* @since
* @since 8.2
*/
public interface AbstractDateFieldServerRpc extends ServerRpc {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,22 +60,22 @@ public class AbstractDateFieldState extends AbstractFieldState {
/**
* The used Locale, can be {@code null}.
*
* @since
* @since 8.2
*/
public String locale;

/**
* Overridden date format string, can be {@code null} if default formatting
* of the components locale is used.
*
* @since
* @since 8.2
*/
public String format;

/**
* Whether the date/time interpretation is lenient.
*
* @since
* @since 8.2
*/
public boolean lenient;

Expand All @@ -87,22 +87,22 @@ public class AbstractDateFieldState extends AbstractFieldState {
*
* The value can be {@code null}
*
* @since
* @since 8.2
*/
public Map<String, Integer> resolutions = new HashMap<>();

/**
* Determines if week numbers are shown in the date selector.
*
* @since
* @since 8.2
*/
public boolean showISOWeekNumbers;

/**
* Was the last entered string parsable? If this flag is false, datefields
* internal validator does not pass.
*
* @since
* @since 8.2
*/
public boolean parsable = true;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public enum DropMode {
* target used when the grid is completely empty. It can also be configured
* to be used automatically when the user has sorted the grid.
*
* @since
* @since 8.2
*/
ON_GRID;
}

0 comments on commit ed57efc

Please sign in to comment.