Fix JavaDoc syntax errors. Add check to circle build. (#791)

* Fix JavaDoc syntax errors. Add check to circle build.

* One more code error

* Added missing tags.
This commit is contained in:
Kai Zimmermann
2019-02-01 10:31:40 +01:00
committed by GitHub
parent 4ee582fe04
commit f9a7194fd5
43 changed files with 196 additions and 193 deletions

View File

@@ -85,7 +85,8 @@ public abstract class AbstractHawkbitUI extends UI implements DetachListener {
protected AbstractHawkbitUI(final EventPushStrategy pushStrategy, final UIEventBus eventBus,
final SpringViewProvider viewProvider, final ApplicationContext context, final DashboardMenu dashboardMenu,
final ErrorView errorview, final NotificationUnreadButton notificationUnreadButton, final UiProperties uiProperties) {
final ErrorView errorview, final NotificationUnreadButton notificationUnreadButton,
final UiProperties uiProperties) {
this.pushStrategy = pushStrategy;
this.eventBus = eventBus;
this.viewProvider = viewProvider;

View File

@@ -27,7 +27,7 @@ public class SpPermissionChecker implements Serializable {
}
/**
* Gets the read Target & Dist Permission.
* Gets the read Target and repository Permission.
*
* @return TARGET_REPOSITORY_READ boolean value
*/

View File

@@ -43,8 +43,6 @@ public class UiProperties implements Serializable {
this.gravatar = gravatar;
}
/**
* Localization information
*/
@@ -57,7 +55,7 @@ public class UiProperties implements Serializable {
private String defaultLocal = "en";
/**
* List of available localizations
* List of available localizations
*/
private List<String> availableLocals = Collections.singletonList("en");

View File

@@ -89,7 +89,7 @@ public class FileTransferHandlerVaadinUpload extends AbstractFileTransferHandler
fileUploadId);
interruptUploadDueToIllegalFilename();
event.getUpload().interruptUpload();
}else if (isFileAlreadyContainedInSoftwareModule(fileUploadId, softwareModule)) {
} else if (isFileAlreadyContainedInSoftwareModule(fileUploadId, softwareModule)) {
LOG.info("File {} already contained in Software Module {}", fileUploadId.getFilename(), softwareModule);
interruptUploadDueToDuplicateFile();
event.getUpload().interruptUpload();

View File

@@ -42,7 +42,7 @@ public final class ColorPickerHelper {
}
/**
* Covert RGB code to {@Color}.
* Covert RGB code to {@link Color}.
*
* @param value
* RGB vale

View File

@@ -61,8 +61,7 @@ import com.vaadin.ui.renderers.ClickableRenderer.RendererClickEvent;
* M is the metadata
*
*/
public abstract class AbstractMetadataPopupLayout<E extends NamedEntity, M extends MetaData>
extends CustomComponent {
public abstract class AbstractMetadataPopupLayout<E extends NamedEntity, M extends MetaData> extends CustomComponent {
private static final String DELETE_BUTTON = "DELETE_BUTTON";
@@ -136,13 +135,13 @@ public abstract class AbstractMetadataPopupLayout<E extends NamedEntity, M exten
* entity for which metadata data is displayed
* @param metaDatakey
* metadata key to be selected
* @return @link{CommonDialogWindow}
* @return {@link CommonDialogWindow}
*/
public CommonDialogWindow getWindow(final E entity, final String metaDatakey) {
selectedEntity = entity;
metadataWindow = new WindowBuilder(SPUIDefinitions.CREATE_UPDATE_WINDOW)
.caption(getMetadataCaption()).content(this).cancelButtonClickListener(event -> onCancel())
metadataWindow = new WindowBuilder(SPUIDefinitions.CREATE_UPDATE_WINDOW).caption(getMetadataCaption())
.content(this).cancelButtonClickListener(event -> onCancel())
.id(UIComponentIdProvider.METADATA_POPUP_ID).layout(mainLayout).i18n(i18n)
.saveDialogCloseListener(new SaveOnDialogCloseListener()).buildCommonDialogWindow();

View File

@@ -554,22 +554,24 @@ public class CommonDialogWindow extends Window {
/**
* Checks if the safe action can executed.
*
* @return <true> = save action can executed <false> = cannot execute
* safe action .
* @return <code>true</code> = save action can executed
* <code>false</code> = cannot execute safe action .
*/
boolean canWindowSaveOrUpdate();
/**
* Checks if the window can closed after the safe action is executed
*
* @return <true> = window will close <false> = will not closed.
* @return <code>true</code> = window will close <code>false</code> =
* will not closed.
*/
default boolean canWindowClose() {
return true;
}
/**
* Saves/Updates action. Is called if canWindowSaveOrUpdate is <true>.
* Saves/Updates action. Is called if canWindowSaveOrUpdate is
* <code>true</code>.
*
*/
void saveOrUpdate();

View File

@@ -37,9 +37,8 @@ public final class UserDetailsFormatter {
/**
* Load user details by the user name and format the user name to max 100
* characters.
*
* @see {@link UserDetailsFormatter#loadAndFormatUsername(String, int)}
* characters. See
* {@link UserDetailsFormatter#loadAndFormatUsername(String, int)}.
*
* @param username
* the user name

View File

@@ -44,8 +44,7 @@ public class TargetMetadataDetailsLayout extends AbstractMetadataDetailsLayout {
* @param targetMetadataPopupLayout
* the target metadata popup layout
*/
public TargetMetadataDetailsLayout(final VaadinMessageSource i18n,
final TargetManagement targetManagement,
public TargetMetadataDetailsLayout(final VaadinMessageSource i18n, final TargetManagement targetManagement,
final TargetMetadataPopupLayout targetMetadataPopupLayout) {
super(i18n);
this.targetManagement = targetManagement;

View File

@@ -291,53 +291,53 @@ public abstract class AbstractGrid<T extends Indexed> extends Grid implements Re
}
/**
* Template method invoked by {@link this#addNewContainerDS()} for creating
* a container instance.
* Template method invoked by {@link #addNewContainerDS()} for creating a
* container instance.
*
* @return new container instance used by the grid.
*/
protected abstract T createContainer();
/**
* Template method invoked by {@link this#addNewContainerDS()} for adding
* Template method invoked by {@link #addNewContainerDS()} for adding
* properties to the container (usually by invoking { @link
* Container#addContainerProperty(Object, Class, Object))})
*/
protected abstract void addContainerProperties();
/**
* Template method invoked by {@link this#addNewContainerDS()} for setting
* the expand ratio of the columns.
* Template method invoked by {@link #addNewContainerDS()} for setting the
* expand ratio of the columns.
*/
protected abstract void setColumnExpandRatio();
/**
* Template method invoked by {@link this#addNewContainerDS()} for setting
* the column names.
* Template method invoked by {@link #addNewContainerDS()} for setting the
* column names.
*/
protected abstract void setColumnHeaderNames();
/**
* Template method invoked by {@link this#addNewContainerDS()} for setting
* the column properties to the grid.
* Template method invoked by {@link #addNewContainerDS()} for setting the
* column properties to the grid.
*/
protected abstract void setColumnProperties();
/**
* Template method invoked by {@link this#addNewContainerDS()} for adding
* Template method invoked by {@link #addNewContainerDS()} for adding
* special column renderers if needed.
*/
protected abstract void addColumnRenderes();
/**
* Template method invoked by {@link this#addNewContainerDS()} that hides
* columns. If a column is hidable and hidden, it can be made visible via
* Template method invoked by {@link #addNewContainerDS()} that hides
* columns. If a column is hideable and hidden, it can be made visible via
* grid column menu.
*/
protected abstract void setHiddenColumns();
/**
* Template method invoked by {@link this#addNewContainerDS()} for adding a
* Template method invoked by {@link #addNewContainerDS()} for adding a
* CellDescriptionGenerator to the grid.
*/
protected abstract CellDescriptionGenerator getDescriptionGenerator();

View File

@@ -236,8 +236,8 @@ public final class SPUIComponentProvider {
}
/**
* Create label which represents the
* {@link BaseEntity#getLastModifiedBy()()} by user name
* Create label which represents the {@link BaseEntity#getLastModifiedBy()}
* by user name
*
* @param i18n
* the i18n

View File

@@ -244,9 +244,8 @@ public class DistributionSetTable extends AbstractNamedVersionTable<Distribution
}
assignSoftwareModulesToDs(softwareModules, ds);
openConfirmationWindowForAssignment(ds.getName(),
softwareModules.stream().map(SoftwareModuleIdName::new)
.toArray(size -> new SoftwareModuleIdName[size]));
openConfirmationWindowForAssignment(ds.getName(), softwareModules.stream().map(SoftwareModuleIdName::new)
.toArray(size -> new SoftwareModuleIdName[size]));
});
}
@@ -256,7 +255,7 @@ public class DistributionSetTable extends AbstractNamedVersionTable<Distribution
for (final Long softwareModuleId : softwareModulesIds) {
final Optional<SoftwareModule> softwareModule = softwareModuleManagement.get(softwareModuleId);
softwareModule.ifPresent(sm -> {
if (validateAssignment(sm, distributionSet)){
if (validateAssignment(sm, distributionSet)) {
assignableModules.add(sm);
}
});
@@ -269,15 +268,13 @@ public class DistributionSetTable extends AbstractNamedVersionTable<Distribution
addSoftwareModulesToConsolidatedDsAssignmentMap(distributionSet, softwareModules);
final Set<SoftwareModuleIdName> softwareModulesThatNeedToBeAssigned = new HashSet<>();
getConsolidatedAssignmentMap(distributionSet).values()
.forEach(softwareModulesThatNeedToBeAssigned::addAll);
getConsolidatedAssignmentMap(distributionSet).values().forEach(softwareModulesThatNeedToBeAssigned::addAll);
manageDistUIState.getAssignedList().put(new DistributionSetIdName(distributionSet),
softwareModulesThatNeedToBeAssigned);
}
private Map<Long, Set<SoftwareModuleIdName>> getConsolidatedAssignmentMap(
final DistributionSet distributionSet) {
private Map<Long, Set<SoftwareModuleIdName>> getConsolidatedAssignmentMap(final DistributionSet distributionSet) {
final DistributionSetIdName distributionSetIdName = new DistributionSetIdName(distributionSet);
final Map<Long, Set<SoftwareModuleIdName>> map;
if (manageDistUIState.getConsolidatedDistSoftwareList().containsKey(distributionSetIdName)) {
@@ -358,8 +355,8 @@ public class DistributionSetTable extends AbstractNamedVersionTable<Distribution
});
int count = 0;
for (final Entry<DistributionSetIdName, Set<SoftwareModuleIdName>> entry : manageDistUIState
.getAssignedList().entrySet()) {
for (final Entry<DistributionSetIdName, Set<SoftwareModuleIdName>> entry : manageDistUIState.getAssignedList()
.entrySet()) {
count += entry.getValue().size();
}
@@ -378,7 +375,6 @@ public class DistributionSetTable extends AbstractNamedVersionTable<Distribution
manageDistUIState.getConsolidatedDistSoftwareList().clear();
}
private boolean validateAssignment(final SoftwareModule sm, final DistributionSet ds) {
final String dsNameAndVersion = HawkbitCommonUtil.concatStrings(":", ds.getName(), ds.getVersion());
final String smNameAndVersion = HawkbitCommonUtil.concatStrings(":", sm.getName(), sm.getVersion());
@@ -388,17 +384,15 @@ public class DistributionSetTable extends AbstractNamedVersionTable<Distribution
if (sm.getType().getMaxAssignments() < 1) {
return false;
}
if (targetManagement.countByFilters(null, null, null, ds.getId(), Boolean.FALSE,
new String[] {}) > 0) {
if (targetManagement.countByFilters(null, null, null, ds.getId(), Boolean.FALSE, new String[] {}) > 0) {
/* Distribution is already assigned */
getNotification().displayValidationError(getI18n().getMessage("message.dist.inuse",
dsNameAndVersion));
getNotification().displayValidationError(getI18n().getMessage("message.dist.inuse", dsNameAndVersion));
return false;
}
if (ds.getModules().contains(sm)) {
/* Already has software module */
getNotification().displayValidationError(getI18n().getMessage("message.software.dist.already.assigned",
smNameAndVersion, dsNameAndVersion));
getNotification().displayValidationError(
getI18n().getMessage("message.software.dist.already.assigned", smNameAndVersion, dsNameAndVersion));
return false;
}
if (!ds.getType().containsModuleType(sm.getType())) {
@@ -408,17 +402,16 @@ public class DistributionSetTable extends AbstractNamedVersionTable<Distribution
return false;
}
if (distributionSetManagement.isInUse(ds.getId())) {
getNotification()
.displayValidationError(getI18n().getMessage("message.error.notification.ds.target.assigned",
ds.getName(), ds.getVersion()));
getNotification().displayValidationError(getI18n()
.getMessage("message.error.notification.ds.target.assigned", ds.getName(), ds.getVersion()));
return false;
}
return true;
}
private boolean isSoftwareModuleDragged(final Long distId, final SoftwareModule sm) {
for (final Entry<DistributionSetIdName, Set<SoftwareModuleIdName>> entry : manageDistUIState
.getAssignedList().entrySet()) {
for (final Entry<DistributionSetIdName, Set<SoftwareModuleIdName>> entry : manageDistUIState.getAssignedList()
.entrySet()) {
if (!distId.equals(entry.getKey().getId())) {
continue;
}

View File

@@ -32,7 +32,8 @@ import com.vaadin.ui.VerticalLayout;
/**
* Pop up layout to display software module metadata.
*/
public class SwMetadataPopupLayout extends AbstractMetadataPopupLayoutVersioned<SoftwareModule, SoftwareModuleMetadata> {
public class SwMetadataPopupLayout
extends AbstractMetadataPopupLayoutVersioned<SoftwareModule, SoftwareModuleMetadata> {
private static final long serialVersionUID = 1L;

View File

@@ -186,7 +186,8 @@ public class CreateOrUpdateFilterHeader extends VerticalLayout implements Button
saveButton = createSaveButton();
searchIcon = createSearchIcon();
helpLink = SPUIComponentProvider.getHelpLink(i18n, uiProperties.getLinks().getDocumentation().getTargetfilterView());
helpLink = SPUIComponentProvider.getHelpLink(i18n,
uiProperties.getLinks().getDocumentation().getTargetfilterView());
closeIcon = createSearchResetIcon();
}

View File

@@ -144,8 +144,8 @@ public class TargetBulkUpdateWindowLayout extends CustomComponent {
progressBar = creatreProgressBar();
targetsCountLabel = getStatusCountLabel();
bulkUploader = getBulkUploadHandler();
linkToSystemConfigHelp = SPUIComponentProvider
.getHelpLink(i18n, uiproperties.getLinks().getDocumentation().getDeploymentView());
linkToSystemConfigHelp = SPUIComponentProvider.getHelpLink(i18n,
uiproperties.getLinks().getDocumentation().getDeploymentView());
windowCaption = new Label(i18n.getMessage("caption.bulk.upload.targets"));
minimizeButton = getMinimizeButton();
closeButton = getCloseButton();

View File

@@ -57,7 +57,7 @@ public class TargetDetails extends AbstractTableDetailsLayout<Target> {
private static final long serialVersionUID = 1L;
private final TargetTagToken targetTagToken;
private final TargetMetadataDetailsLayout targetMetadataTable;
private final TargetAddUpdateWindowLayout targetAddUpdateWindowLayout;
@@ -84,14 +84,12 @@ public class TargetDetails extends AbstractTableDetailsLayout<Target> {
this.targetTagToken = new TargetTagToken(permissionChecker, i18n, uiNotification, eventBus, managementUIState,
tagManagement, targetManagement);
this.targetAddUpdateWindowLayout = new TargetAddUpdateWindowLayout(i18n, targetManagement, eventBus,
uiNotification,
entityFactory, targetTable);
uiNotification, entityFactory, targetTable);
this.uiNotification = uiNotification;
this.targetManagement = targetManagement;
this.deploymentManagement = deploymentManagement;
this.targetMetadataPopupLayout = targetMetadataPopupLayout;
this.targetMetadataTable = new TargetMetadataDetailsLayout(i18n, targetManagement,
targetMetadataPopupLayout);
this.targetMetadataTable = new TargetMetadataDetailsLayout(i18n, targetManagement, targetMetadataPopupLayout);
addDetailsTab();
restoreState();
}

View File

@@ -49,10 +49,8 @@ public class TargetMetadataPopupLayout extends AbstractMetadataPopupLayout<Targe
@Override
protected MetaData createMetadata(final Target entity, final String key, final String value) {
final TargetMetadata metaData = targetManagement
.createMetaData(entity.getControllerId(),
Collections.singletonList(entityFactory.generateTargetMetadata(key, value)))
.get(0);
final TargetMetadata metaData = targetManagement.createMetaData(entity.getControllerId(),
Collections.singletonList(entityFactory.generateTargetMetadata(key, value))).get(0);
setSelectedEntity(metaData.getTarget());
return metaData;
}

View File

@@ -51,7 +51,8 @@ public class TargetTableLayout extends AbstractTableLayout<TargetTable> {
eventBus, targetManagement, entityFactory, permissionChecker);
this.eventBus = eventBus;
this.targetDetails = new TargetDetails(i18n, eventBus, permissionChecker, managementUIState, uiNotification,
tagManagement, targetManagement, targetMetadataPopupLayout, deploymentManagement, entityFactory, targetTable);
tagManagement, targetManagement, targetMetadataPopupLayout, deploymentManagement, entityFactory,
targetTable);
this.targetTableHeader = new TargetTableHeader(i18n, permissionChecker, eventBus, uiNotification,
managementUIState, managementViewClientCriterion, targetManagement, deploymentManagement, uiProperties,
entityFactory, uiNotification, tagManagement, distributionSetManagement, uiExecutor, targetTable);

View File

@@ -310,8 +310,8 @@ public final class DashboardMenu extends CustomComponent {
/**
* Is a View available.
*
* @return the accessibleViewsEmpty <true> no rights for any view <false> a
* view is available
* @return the accessibleViewsEmpty <code>true</code> no rights for any view
* <code>false</code> a view is available
*/
public boolean isAccessibleViewsEmpty() {
return accessibleViewsEmpty;
@@ -352,7 +352,7 @@ public final class DashboardMenu extends CustomComponent {
*
* @param viewName
* the view name
* @return <true> = denied, <false> = accessible
* @return <code>true</code> = denied, <code>false</code> = accessible
*/
public boolean isAccessDenied(final String viewName) {
final List<DashboardMenuItem> accessibleViews = getAccessibleViews();

View File

@@ -1107,8 +1107,7 @@ public class AddUpdateRolloutWindowLayout extends GridLayout {
private enum ERROR_THRESHOLD_OPTIONS {
PERCENT("label.errorthreshold.option.percent"),
COUNT("label.errorthreshold.option.count");
PERCENT("label.errorthreshold.option.percent"), COUNT("label.errorthreshold.option.count");
private final String value;
@@ -1117,7 +1116,7 @@ public class AddUpdateRolloutWindowLayout extends GridLayout {
}
private String getValue(final VaadinMessageSource i18n) {
return i18n.getMessage(value);
return i18n.getMessage(value);
}
}
}

View File

@@ -128,8 +128,8 @@ public class AuthenticationConfigurationView extends BaseConfigurationView
gridLayout.addComponent(downloadAnonymousCheckBox, 0, 3);
gridLayout.addComponent(anonymousDownloadAuthenticationConfigurationItem, 1, 3);
final Link linkToSecurityHelp = SPUIComponentProvider
.getHelpLink(i18n, uiProperties.getLinks().getDocumentation().getSecurity());
final Link linkToSecurityHelp = SPUIComponentProvider.getHelpLink(i18n,
uiProperties.getLinks().getDocumentation().getSecurity());
gridLayout.addComponent(linkToSecurityHelp, 2, 3);
gridLayout.setComponentAlignment(linkToSecurityHelp, Alignment.BOTTOM_RIGHT);

View File

@@ -73,8 +73,8 @@ public class RolloutConfigurationView extends BaseConfigurationView
hLayout.addComponent(approvalCheckbox);
hLayout.addComponent(approvalConfigurationItem);
final Link linkToApprovalHelp = SPUIComponentProvider
.getHelpLink(i18n, uiProperties.getLinks().getDocumentation().getRollout());
final Link linkToApprovalHelp = SPUIComponentProvider.getHelpLink(i18n,
uiProperties.getLinks().getDocumentation().getRollout());
hLayout.addComponent(linkToApprovalHelp);
hLayout.setComponentAlignment(linkToApprovalHelp, Alignment.BOTTOM_RIGHT);

View File

@@ -153,8 +153,8 @@ public class TenantConfigurationDashboardView extends CustomComponent implements
undoConfigurationBtn.addClickListener(event -> undoConfiguration());
hlayout.addComponent(undoConfigurationBtn);
final Link linkToSystemConfigHelp = SPUIComponentProvider
.getHelpLink(i18n, uiProperties.getLinks().getDocumentation().getSystemConfigurationView());
final Link linkToSystemConfigHelp = SPUIComponentProvider.getHelpLink(i18n,
uiProperties.getLinks().getDocumentation().getSystemConfigurationView());
hlayout.addComponent(linkToSystemConfigHelp);
return hlayout;

View File

@@ -143,7 +143,7 @@ public class DurationField extends DateField {
* Sets the duration value
*
* @param duration
* duration, only values <= 23:59:59 are excepted
* duration, only values less then 23:59:59 are excepted
*/
public void setDuration(@NotNull final Duration duration) {
if (duration.compareTo(MAXIMUM_DURATION) > 0) {

View File

@@ -134,7 +134,7 @@ public final class SPUILabelDefinitions {
*/
public static final String AUTO_ASSIGN_DISTRIBUTION_SET = "autoAssignDistributionSet";
/**
* ASSIGNED DISTRIBUTION Name & Version.
* ASSIGNED DISTRIBUTION Name and Version.
*/
public static final String ASSIGNED_DISTRIBUTION_NAME_VER = "assignedDistNameVersion";
@@ -144,7 +144,7 @@ public final class SPUILabelDefinitions {
public static final String INSTALLED_DISTRIBUTION_ID = "installedDistributionSet.id";
/**
* INSTALLED DISTRIBUTION Name & Version.
* INSTALLED DISTRIBUTION Name and Version.
*/
public static final String INSTALLED_DISTRIBUTION_NAME_VER = "installedDistNameVersion";