From 51ba6b518e0dce54c7a032343542147a9856d438 Mon Sep 17 00:00:00 2001 From: asharani-murugesh Date: Mon, 7 Mar 2016 10:39:39 +0100 Subject: [PATCH] Added javadoc Signed-off-by: asharani-murugesh --- .../client/HtmlButtonRendererConnector.java | 6 ++++++ .../client/HtmlLabelRendererConnector.java | 7 +++++++ .../client/LinkRendererConnector.java | 7 +++++++ .../client/renderers/HtmlButtonRenderer.java | 6 ++++++ .../client/renderers/HtmlLabelRenderer.java | 5 +++++ .../client/renderers/LinkRenderer.java | 5 +++++ .../renderers/HtmlButtonRenderer.java | 6 ++++++ .../renderers/HtmlLabelRenderer.java | 5 +++++ .../customrenderers/renderers/LinkRenderer.java | 5 +++++ .../ui/rollout/rollout/RolloutListGrid.java | 5 +++++ .../rolloutgroup/RolloutGroupListGrid.java | 5 +++++ .../RolloutGroupTargetsBeanQuery.java | 17 +++++++++-------- .../RolloutGroupTargetsCountLabelMessage.java | 3 +-- .../RolloutGroupTargetsListGrid.java | 5 +++++ 14 files changed, 77 insertions(+), 10 deletions(-) diff --git a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/client/HtmlButtonRendererConnector.java b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/client/HtmlButtonRendererConnector.java index 3f2b23b54..3dbff6b4b 100644 --- a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/client/HtmlButtonRendererConnector.java +++ b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/client/HtmlButtonRendererConnector.java @@ -8,9 +8,15 @@ */ package org.eclipse.hawkbit.ui.customrenderers.client; +import org.eclipse.hawkbit.ui.customrenderers.renderers.HtmlButtonRenderer; + import com.vaadin.client.connectors.ButtonRendererConnector; import com.vaadin.shared.ui.Connect; +/** + * A connector for {@link HtmlButtonRenderer}. + * + */ @Connect(org.eclipse.hawkbit.ui.customrenderers.renderers.HtmlButtonRenderer.class) public class HtmlButtonRendererConnector extends ButtonRendererConnector { private static final long serialVersionUID = 7987417436367399331L; diff --git a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/client/HtmlLabelRendererConnector.java b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/client/HtmlLabelRendererConnector.java index a64cd6bea..fea64318d 100644 --- a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/client/HtmlLabelRendererConnector.java +++ b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/client/HtmlLabelRendererConnector.java @@ -8,9 +8,16 @@ */ package org.eclipse.hawkbit.ui.customrenderers.client; +import org.eclipse.hawkbit.ui.customrenderers.renderers.HtmlLabelRenderer; + import com.vaadin.client.connectors.AbstractRendererConnector; import com.vaadin.shared.ui.Connect; +/** + * + * A connector for {@link HtmlLabelRenderer}. + * + */ @Connect(org.eclipse.hawkbit.ui.customrenderers.renderers.HtmlLabelRenderer.class) public class HtmlLabelRendererConnector extends AbstractRendererConnector { diff --git a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/client/LinkRendererConnector.java b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/client/LinkRendererConnector.java index 21cf7128e..cb25377b5 100644 --- a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/client/LinkRendererConnector.java +++ b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/client/LinkRendererConnector.java @@ -8,9 +8,16 @@ */ package org.eclipse.hawkbit.ui.customrenderers.client; +import org.eclipse.hawkbit.ui.customrenderers.renderers.LinkRenderer; + import com.vaadin.client.connectors.ButtonRendererConnector; import com.vaadin.shared.ui.Connect; +/** + * + * A connector for {@link LinkRenderer}. + * + */ @Connect(org.eclipse.hawkbit.ui.customrenderers.renderers.LinkRenderer.class) public class LinkRendererConnector extends ButtonRendererConnector { private static final long serialVersionUID = 7987417436367399331L; diff --git a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/client/renderers/HtmlButtonRenderer.java b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/client/renderers/HtmlButtonRenderer.java index 45c8f4f0d..1e4a35002 100644 --- a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/client/renderers/HtmlButtonRenderer.java +++ b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/client/renderers/HtmlButtonRenderer.java @@ -13,6 +13,12 @@ import com.vaadin.client.renderers.ButtonRenderer; import com.vaadin.client.ui.VButton; import com.vaadin.client.widget.grid.RendererCellReference; +/** + * + * Renders button with provided HTML content. + * Used to display button with icons. + * + */ public class HtmlButtonRenderer extends ButtonRenderer { @Override public void render(RendererCellReference cell, String text, Button button) { diff --git a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/client/renderers/HtmlLabelRenderer.java b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/client/renderers/HtmlLabelRenderer.java index a0ceb9532..156daf966 100644 --- a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/client/renderers/HtmlLabelRenderer.java +++ b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/client/renderers/HtmlLabelRenderer.java @@ -16,6 +16,11 @@ import com.vaadin.client.renderers.WidgetRenderer; import com.vaadin.client.ui.VLabel; import com.vaadin.client.widget.grid.RendererCellReference; +/** + * + * Renders label with provided value and style. + * + */ public class HtmlLabelRenderer extends WidgetRenderer { @Override diff --git a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/client/renderers/LinkRenderer.java b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/client/renderers/LinkRenderer.java index 535e71ef9..0abe4044b 100644 --- a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/client/renderers/LinkRenderer.java +++ b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/client/renderers/LinkRenderer.java @@ -13,6 +13,11 @@ import com.vaadin.client.renderers.ButtonRenderer; import com.vaadin.client.ui.VButton; import com.vaadin.client.widget.grid.RendererCellReference; +/** + * + * Renders link with provided text. + * + */ public class LinkRenderer extends ButtonRenderer { @Override public void render(RendererCellReference cell, String text, Button button) { diff --git a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/renderers/HtmlButtonRenderer.java b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/renderers/HtmlButtonRenderer.java index f4dfd7f88..634970883 100644 --- a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/renderers/HtmlButtonRenderer.java +++ b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/renderers/HtmlButtonRenderer.java @@ -10,6 +10,12 @@ package org.eclipse.hawkbit.ui.customrenderers.renderers; import com.vaadin.ui.renderers.ButtonRenderer; +/** + * + * Renders button with provided HTML content. + * Used to display button with icons. + * + */ public class HtmlButtonRenderer extends ButtonRenderer { private static final long serialVersionUID = -1242995370043404892L; public HtmlButtonRenderer() { diff --git a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/renderers/HtmlLabelRenderer.java b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/renderers/HtmlLabelRenderer.java index a67e54bca..ec801ad2e 100644 --- a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/renderers/HtmlLabelRenderer.java +++ b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/renderers/HtmlLabelRenderer.java @@ -10,6 +10,11 @@ package org.eclipse.hawkbit.ui.customrenderers.renderers; import com.vaadin.ui.Grid.AbstractRenderer; +/** + * + * Renders label with provided value and style. + * + */ public class HtmlLabelRenderer extends AbstractRenderer { private static final long serialVersionUID = -7675588068526774915L; diff --git a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/renderers/LinkRenderer.java b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/renderers/LinkRenderer.java index 010e8e615..dbf0ae5da 100644 --- a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/renderers/LinkRenderer.java +++ b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/customrenderers/renderers/LinkRenderer.java @@ -10,6 +10,11 @@ package org.eclipse.hawkbit.ui.customrenderers.renderers; import com.vaadin.ui.renderers.ButtonRenderer; +/** + * + * Renders link with provided text. + * + */ public class LinkRenderer extends ButtonRenderer { private static final long serialVersionUID = -1242995370043404892L; public LinkRenderer() { diff --git a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/rollout/rollout/RolloutListGrid.java b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/rollout/rollout/RolloutListGrid.java index 21c923a3a..5fadc5d2f 100644 --- a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/rollout/rollout/RolloutListGrid.java +++ b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/rollout/rollout/RolloutListGrid.java @@ -60,6 +60,11 @@ import com.vaadin.ui.Window; import com.vaadin.ui.renderers.ClickableRenderer.RendererClickEvent; import com.vaadin.ui.renderers.HtmlRenderer; +/** + * + * Rollout list grid component. + * + */ @SpringComponent @ViewScope public class RolloutListGrid extends AbstractGrid { diff --git a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/rollout/rolloutgroup/RolloutGroupListGrid.java b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/rollout/rolloutgroup/RolloutGroupListGrid.java index 8c2fa398f..7f74ac18f 100644 --- a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/rollout/rolloutgroup/RolloutGroupListGrid.java +++ b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/rollout/rolloutgroup/RolloutGroupListGrid.java @@ -51,6 +51,11 @@ import com.vaadin.spring.annotation.ViewScope; import com.vaadin.ui.renderers.ClickableRenderer.RendererClickEvent; import com.vaadin.ui.renderers.HtmlRenderer; +/** + * + * Rollout group list grid component. + * + */ @SpringComponent @ViewScope public class RolloutGroupListGrid extends AbstractGrid { diff --git a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/rollout/rolloutgrouptargets/RolloutGroupTargetsBeanQuery.java b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/rollout/rolloutgrouptargets/RolloutGroupTargetsBeanQuery.java index d9c25d943..097e076be 100644 --- a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/rollout/rolloutgrouptargets/RolloutGroupTargetsBeanQuery.java +++ b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/rollout/rolloutgrouptargets/RolloutGroupTargetsBeanQuery.java @@ -31,8 +31,8 @@ import org.vaadin.addons.lazyquerycontainer.AbstractBeanQuery; import org.vaadin.addons.lazyquerycontainer.QueryDefinition; /** - * @author gah6kor - * + * Simple implementation of generics bean query which dynamically loads a batch + * of {@link ProxyTarget} beans. */ public class RolloutGroupTargetsBeanQuery extends AbstractBeanQuery { @@ -83,8 +83,9 @@ public class RolloutGroupTargetsBeanQuery extends AbstractBeanQuery if (startIndex == 0 && firstPageTargetSets != null) { rolloutGroupTargetsList = firstPageTargetSets.getContent(); } else if (null != rolloutGroup) { - rolloutGroupTargetsList = getRolloutGroupManagement().findAllTargetsWithActionStatus( - new PageRequest(startIndex / count, count), rolloutGroup).getContent(); + rolloutGroupTargetsList = getRolloutGroupManagement() + .findAllTargetsWithActionStatus(new PageRequest(startIndex / count, count), rolloutGroup) + .getContent(); } return getProxyRolloutGroupTargetsList(rolloutGroupTargetsList); } @@ -113,8 +114,8 @@ public class RolloutGroupTargetsBeanQuery extends AbstractBeanQuery prxyTarget.setTargetInfo(targ.getTargetInfo()); prxyTarget.setId(targ.getId()); if (targ.getAssignedDistributionSet() != null) { - prxyTarget.setAssignedDistNameVersion(HawkbitCommonUtil.getFormattedNameVersion(targ - .getAssignedDistributionSet().getName(), targ.getAssignedDistributionSet().getVersion())); + prxyTarget.setAssignedDistNameVersion(HawkbitCommonUtil.getFormattedNameVersion( + targ.getAssignedDistributionSet().getName(), targ.getAssignedDistributionSet().getVersion())); } proxyTargetBeans.add(prxyTarget); @@ -133,8 +134,8 @@ public class RolloutGroupTargetsBeanQuery extends AbstractBeanQuery public int size() { long size = 0; if (null != rolloutGroup) { - firstPageTargetSets = getRolloutGroupManagement().findAllTargetsWithActionStatus( - new PageRequest(0, SPUIDefinitions.PAGE_SIZE, sort), rolloutGroup); + firstPageTargetSets = getRolloutGroupManagement() + .findAllTargetsWithActionStatus(new PageRequest(0, SPUIDefinitions.PAGE_SIZE, sort), rolloutGroup); size = firstPageTargetSets.getTotalElements(); } getRolloutUIState().setRolloutGroupTargetsTotalCount(size); diff --git a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/rollout/rolloutgrouptargets/RolloutGroupTargetsCountLabelMessage.java b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/rollout/rolloutgrouptargets/RolloutGroupTargetsCountLabelMessage.java index cc6cec189..8631eb8c7 100644 --- a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/rollout/rolloutgrouptargets/RolloutGroupTargetsCountLabelMessage.java +++ b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/rollout/rolloutgrouptargets/RolloutGroupTargetsCountLabelMessage.java @@ -30,8 +30,7 @@ import com.vaadin.spring.annotation.ViewScope; import com.vaadin.ui.Label; /** - * count message label for the targets of the rollout group. - * + * Count message label for the targets of the rollout group. */ @SpringComponent @ViewScope diff --git a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/rollout/rolloutgrouptargets/RolloutGroupTargetsListGrid.java b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/rollout/rolloutgrouptargets/RolloutGroupTargetsListGrid.java index bc76ef42b..ff080076c 100644 --- a/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/rollout/rolloutgrouptargets/RolloutGroupTargetsListGrid.java +++ b/hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/rollout/rolloutgrouptargets/RolloutGroupTargetsListGrid.java @@ -41,6 +41,11 @@ import com.vaadin.server.FontAwesome; import com.vaadin.spring.annotation.SpringComponent; import com.vaadin.spring.annotation.ViewScope; +/** + * + * Grid component with targets of rollout group. + * + */ @SpringComponent @ViewScope public class RolloutGroupTargetsListGrid extends AbstractGrid {