lingwei.kong/hawkbit
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

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

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files

24
hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ControllerManagement.java
View File

@@ -374,19 +374,19 @@ public interface ControllerManagement {
/**
* Retrieves the specified number of messages from action history of the
* given {@link Action} based on messageCount. Regardless of the value of
* messageCount, in order to restrict resource utilization by controllers,
* messageCount, in order to restrict resource utilisation by controllers,
* maximum number of messages that are retrieved from database is limited by
* {@link RepositoryConstants#MAX_ACTION_HISTORY_MSG_COUNT}. messageCount <
* 0, retrieves the maximum allowed number of action status messages from
* history; messageCount = 0, does not retrieve any message; and
* messageCount > 0, retrieves the specified number of messages, limited by
* maximum allowed number. A controller sends the feedback for an
* {@link ActionStatus} as a list of messages; while returning the messages,
* even though the messages from multiple {@link ActionStatus} are retrieved
* in descending order by the reported time
* ({@link ActionStatus#getOccurredAt()}), i.e. latest ActionStatus first,
* the sub-ordering of messages from within single {@link ActionStatus} is
* unspecified.
* {@link RepositoryConstants#MAX_ACTION_HISTORY_MSG_COUNT}. messageCount
* less then zero, retrieves the maximum allowed number of action status
* messages from history; messageCount equal zero, does not retrieve any
* message; and messageCount larger then zero, retrieves the specified
* number of messages, limited by maximum allowed number. A controller sends
* the feedback for an {@link ActionStatus} as a list of messages; while
* returning the messages, even though the messages from multiple
* {@link ActionStatus} are retrieved in descending order by the reported
* time ({@link ActionStatus#getOccurredAt()}), i.e. latest ActionStatus
* first, the sub-ordering of messages from within single
* {@link ActionStatus} is unspecified.
*
* @param actionId
* to be filtered on

10
hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/UnsupportedSoftwareModuleForThisDistributionSetException.java
View File

@@ -16,17 +16,11 @@ import org.eclipse.hawkbit.repository.model.SoftwareModule;
/**
* Thrown if user tries to add a {@link SoftwareModule} to a
* {@link DistributionSet} that is not defined by< the
* {@link DistributionSet} that is not defined by the
* {@link DistributionSetType}.
*
*
*
*
*/
public class UnsupportedSoftwareModuleForThisDistributionSetException extends AbstractServerRtException {
/**
*
*/
private static final long serialVersionUID = 1L;
/**

26
hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetFilterQuery.java
View File

@@ -13,22 +13,22 @@ package org.eclipse.hawkbit.repository.model;
*
* Supported operators.
* <ul>
* <li>Equal to : ==</li>
* <li>Not equal to : !=</li>
* <li>Less than : =lt= or <</li>
* <li>Less than or equal to : =le= or <=</li>
* <li>Greater than operator : =gt= or ></li>
* <li>Greater than or equal to : =ge= or >=</li>
* <li>{@code Equal to : ==}</li>
* <li>{@code Not equal to : !=}</li>
* <li>{@code Less than : =lt= or <}</li>
* <li>{@code Less than or equal to : =le= or <=}</li>
* <li>{@code Greater than operator : =gt= or >}</li>
* <li>{@code Greater than or equal to : =ge= or >=}</li>
* </ul>
* Examples of RSQL expressions in both FIQL-like and alternative notation:
* <ul>
* <li>version==2.0.0</li>
* <li>name==targetId1;description==plugAndPlay</li>
* <li>name==targetId1 and description==plugAndPlay</li>
* <li>name==targetId1;description==plugAndPlay</li>
* <li>name==targetId1 and description==plugAndPlay</li>
* <li>name==targetId1,description==plugAndPlay,updateStatus==UNKNOWN</li>
* <li>name==targetId1 or description==plugAndPlay or updateStatus==UNKNOWN</li>
* <li>{@code version==2.0.0}</li>
* <li>{@code name==targetId1;description==plugAndPlay}</li>
* <li>{@code name==targetId1 and description==plugAndPlay}</li>
* <li>{@code name==targetId1;description==plugAndPlay}</li>
* <li>{@code name==targetId1 and description==plugAndPlay}</li>
* <li>{@code name==targetId1,description==plugAndPlay,updateStatus==UNKNOWN}</li>
* <li>{@code name==targetId1 or description==plugAndPlay or updateStatus==UNKNOWN}</li>
* </ul>
*
*/

2
hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/ActionRepository.java
View File

@@ -431,7 +431,7 @@ public interface ActionRepository extends BaseEntityRepository<JpaAction, Long>,
* @param pageable
* page parameters
* @param rolloutId
* the rollout the actions beglong to
* the rollout the actions belong to
* @param actionStatus
* the status of the actions
* @return the actions referring a specific rollout an in a specific status

40
hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/EntityInterceptor.java → hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/EntityInterceptor.java
View File

@@ -6,77 +6,85 @@
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*/
package org.eclipse.hawkbit.repository.model;
package org.eclipse.hawkbit.repository.jpa;
import javax.persistence.PostLoad;
import javax.persistence.PostPersist;
import javax.persistence.PostRemove;
import javax.persistence.PostUpdate;
import javax.persistence.PrePersist;
import javax.persistence.PreRemove;
import javax.persistence.PreUpdate;
/**
* Interface for the entity interceptor lifecycle.
*/
// Exception squid:EmptyStatementUsageCheck - don't want to force users to
// impelemnt all methods
// implement all methods
@SuppressWarnings("squid:EmptyStatementUsageCheck")
public interface EntityInterceptor {
/**
* Callback for the {@link @PrePersist} lifecycle event.
* Callback for the {@link PrePersist} lifecycle event.
*
* @param entity
* the model entity
*/
default void prePersist(final Object entity) {
};
}
/**
* Callback for the {@link @PostPersist} lifecycle event.
* Callback for the {@link PostPersist} lifecycle event.
*
* @param entity
* the model entity
*/
default void postPersist(final Object entity) {
};
}
/**
* Callback for the {@link @PostRemove} lifecycle event.
* Callback for the {@link PostRemove} lifecycle event.
*
* @param entity
* the model entity
*/
default void postRemove(final Object entity) {
};
}
/**
* Callback for the {@link @PreRemove} lifecycle event.
* Callback for the {@link PreRemove} lifecycle event.
*
* @param entity
* the model entity
*/
default void preRemove(final Object entity) {
};
}
/**
* Callback for the {@link @PostLoad} lifecycle event.
* Callback for the {@link PostLoad} lifecycle event.
*
* @param entity
* the model entity
*/
default void postLoad(final Object entity) {
};
}
/**
* Callback for the {@link @PreUpdate} lifecycle event.
* Callback for the {@link PreUpdate} lifecycle event.
*
* @param entity
* the model entity
*/
default void preUpdate(final Object entity) {
};
}
/**
* Callback for the {@link @PostUpdate} lifecycle event.
* Callback for the {@link PostUpdate} lifecycle event.
*
* @param entity
* the model entity
*/
default void postUpdate(final Object entity) {
};
}
}

2
hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/model/EntityInterceptorListener.java
View File

@@ -18,8 +18,8 @@ import javax.persistence.PrePersist;
import javax.persistence.PreRemove;
import javax.persistence.PreUpdate;
import org.eclipse.hawkbit.repository.jpa.EntityInterceptor;
import org.eclipse.hawkbit.repository.jpa.model.helper.EntityInterceptorHolder;
import org.eclipse.hawkbit.repository.model.EntityInterceptor;
/**
* Entity listener which calls the callback's of all registered entity

2
hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/model/helper/EntityInterceptorHolder.java
View File

@@ -11,7 +11,7 @@ package org.eclipse.hawkbit.repository.jpa.model.helper;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.hawkbit.repository.model.EntityInterceptor;
import org.eclipse.hawkbit.repository.jpa.EntityInterceptor;
import org.springframework.beans.factory.annotation.Autowired;
/**

22
hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/rsql/RSQLUtility.java
View File

@@ -65,21 +65,21 @@ import cz.jirutka.rsql.parser.ast.RSQLVisitor;
* entities. RSQL parser library: https://github.com/jirutka/rsql-parser
*
* <ul>
* <li>Equal to : ==</li>
* <li>Not equal to : !=</li>
* <li>Less than : =lt= or <</li>
* <li>Less than or equal to : =le= or <=</li>
* <li>Greater than operator : =gt= or ></li>
* <li>Greater than or equal to : =ge= or >=</li>
* <li>{@code Equal to : ==}</li>
* <li>{@code Not equal to : !=}</li>
* <li>{@code Less than : =lt= or <}</li>
* <li>{@code Less than or equal to : =le= or <=}</li>
* <li>{@code Greater than operator : =gt= or >}</li>
* <li>{@code Greater than or equal to : =ge= or >=}</li>
* </ul>
* <p>
* Examples of RSQL expressions in both FIQL-like and alternative notation:
* <ul>
* <li>version==2.0.0</li>
* <li>name==targetId1;description==plugAndPlay</li>
* <li>name==targetId1 and description==plugAndPlay</li>
* <li>name==targetId1,description==plugAndPlay,updateStatus==UNKNOWN</li>
* <li>name==targetId1 or description==plugAndPlay or updateStatus==UNKNOWN</li>
* <li>{@code version==2.0.0}</li>
* <li>{@code name==targetId1;description==plugAndPlay}</li>
* <li>{@code name==targetId1 and description==plugAndPlay}</li>
* <li>{@code name==targetId1,description==plugAndPlay,updateStatus==UNKNOWN}</li>
* <li>{@code name==targetId1 or description==plugAndPlay or updateStatus==UNKNOWN}</li>
* </ul>
* <p>
* There is also a mechanism that allows to refer to known macros that can

2
hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/specifications/DistributionSetTypeSpecification.java
View File

@@ -52,7 +52,7 @@ public final class DistributionSetTypeSpecification {
/**
* {@link Specification} for retrieving {@link DistributionSetType} with
* given {@link DistributionSetType#getName())} including fetching the
* given {@link DistributionSetType#getName()} including fetching the
* elements list.
*
* @param name

2
hawkbit-repository/hawkbit-repository-jpa/src/test/java/org/eclipse/hawkbit/repository/jpa/model/EntityInterceptorListenerTest.java
View File

@@ -11,8 +11,8 @@ package org.eclipse.hawkbit.repository.jpa.model;
import static org.assertj.core.api.Assertions.assertThat;
import org.eclipse.hawkbit.repository.jpa.AbstractJpaIntegrationTest;
import org.eclipse.hawkbit.repository.jpa.EntityInterceptor;
import org.eclipse.hawkbit.repository.jpa.model.helper.EntityInterceptorHolder;
import org.eclipse.hawkbit.repository.model.EntityInterceptor;
import org.eclipse.hawkbit.repository.model.SoftwareModuleType;
import org.eclipse.hawkbit.repository.model.Target;
import org.junit.After;

11
hawkbit-repository/hawkbit-repository-test/src/main/java/org/eclipse/hawkbit/repository/test/util/TestdataFactory.java
View File

@@ -104,19 +104,19 @@ public class TestdataFactory {
public static final String DS_TYPE_DEFAULT = "test_default_ds_type";
/**
* Key of test "os" {@link SoftwareModuleType} -> mandatory firmware in
* Key of test "os" {@link SoftwareModuleType} : mandatory firmware in
* {@link #DS_TYPE_DEFAULT}.
*/
public static final String SM_TYPE_OS = "os";
/**
* Key of test "runtime" {@link SoftwareModuleType} -> optional firmware in
* Key of test "runtime" {@link SoftwareModuleType} : optional firmware in
* {@link #DS_TYPE_DEFAULT}.
*/
public static final String SM_TYPE_RT = "runtime";
/**
* Key of test "application" {@link SoftwareModuleType} -> optional software
* Key of test "application" {@link SoftwareModuleType} : optional software
* in {@link #DS_TYPE_DEFAULT}.
*/
public static final String SM_TYPE_APP = "application";
@@ -466,9 +466,8 @@ public class TestdataFactory {
for (int i = 0; i < 3; i++) {
final String artifactData = "some test data" + i;
final InputStream stubInputStream = IOUtils.toInputStream(artifactData, Charset.forName("UTF-8"));
artifacts.add(
artifactManagement.create(new ArtifactUpload(stubInputStream, moduleId, "filename" + i, false,
artifactData.length())));
artifacts.add(artifactManagement.create(
new ArtifactUpload(stubInputStream, moduleId, "filename" + i, false, artifactData.length())));
}

2
hawkbit-repository/hawkbit-repository-test/src/main/java/org/eclipse/hawkbit/repository/test/util/WithUser.java
View File

@@ -47,7 +47,7 @@ public @interface WithUser {
/**
* Should tenant auto created.
*
* @return <true> = auto create <false> not create
* @return <code>true</code> = auto create <code>false</code> not create
*/
boolean autoCreateTenant() default true;