Skip to content

Commit

Permalink
fix javadoc errors
Browse files Browse the repository at this point in the history
  • Loading branch information
@bischoffz
bischoffz committed Aug 19, 2024
1 parent 9957b86 commit 07c0389
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 56 deletions.
5 changes: 0 additions & 5 deletions simulation/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,6 @@
<configuration>
<doclint>all,-missing</doclint>
<additionalDependencies>
<additionalDependency>
<groupId>gov.hhs.aspr.ms</groupId>
<artifactId>util</artifactId>
<version>${util.version}</version>
</additionalDependency>
<additionalDependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-api</artifactId>
Expand Down
33 changes: 15 additions & 18 deletions simulation/src/main/java/gov/hhs/aspr/ms/gcm/simulation/nucleus/ConsumerActorPlan.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,11 @@ public final class ConsumerActorPlan extends ActorPlan {
* Constructs the plan scheduled for the given time active status arrivalId and
* consumer
*
* @throw {@link ContractException}
* <ul>
* <li>{@linkplain NucleusError#NULL_PLAN_CONSUMER} if the consumer is
* null</li>
* </ul>
*
* @throws ContractException
* <ul>
* <li>{@linkplain NucleusError#NULL_PLAN_CONSUMER} if
* the consumer is null</li>
* </ul>
*/
public ConsumerActorPlan(double time, boolean active, long arrivalId, Consumer<ActorContext> consumer) {
super(time, active, arrivalId);
Expand All @@ -32,12 +31,11 @@ public ConsumerActorPlan(double time, boolean active, long arrivalId, Consumer<A
* be active.The arrival id is set to -1L indicating that this is a new,
* non-deserialized plan.
*
* @throw {@link ContractException}
* <ul>
* <li>{@linkplain NucleusError#NULL_PLAN_CONSUMER} if the consumer is
* null</li>
* </ul>
*
* @throws ContractException
* <ul>
* <li>{@linkplain NucleusError#NULL_PLAN_CONSUMER} if
* the consumer is null</li>
* </ul>
*/
public ConsumerActorPlan(double time, Consumer<ActorContext> consumer) {
super(time);
Expand All @@ -52,12 +50,11 @@ public ConsumerActorPlan(double time, Consumer<ActorContext> consumer) {
* The arrival id is set to -1L indicating that this is a new, non-deserialized
* plan.
*
* @throw {@link ContractException}
* <ul>
* <li>{@linkplain NucleusError#NULL_PLAN_CONSUMER} if the consumer is
* null</li>
* </ul>
*
* @throws ContractException
* <ul>
* <li>{@linkplain NucleusError#NULL_PLAN_CONSUMER} if
* the consumer is null</li>
* </ul>
*/
public ConsumerActorPlan(double time, boolean active, Consumer<ActorContext> consumer) {
super(time, active);
Expand Down
35 changes: 16 additions & 19 deletions simulation/src/main/java/gov/hhs/aspr/ms/gcm/simulation/nucleus/ConsumerDataManagerPlan.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,18 @@
import gov.hhs.aspr.ms.util.errors.ContractException;

public class ConsumerDataManagerPlan extends DataManagerPlan {

private final Consumer<DataManagerContext> consumer;

/**
* Constructs the plan scheduled for the given time active status arrivalId and
* consumer
*
* @throw {@link ContractException}
* <ul>
* <li>{@linkplain NucleusError#NULL_PLAN_CONSUMER} if the consumer is
* null</li>
* </ul>
*
* @throws ContractException
* <ul>
* <li>{@linkplain NucleusError#NULL_PLAN_CONSUMER} if
* the consumer is null</li>
* </ul>
*/
public ConsumerDataManagerPlan(double time, boolean active, long arrivalId, Consumer<DataManagerContext> consumer) {
super(time, active, arrivalId);
Expand All @@ -33,12 +32,11 @@ public ConsumerDataManagerPlan(double time, boolean active, long arrivalId, Cons
* The arrival id is set to -1L indicating that this is a new, non-deserialized
* plan.
*
* @throw {@link ContractException}
* <ul>
* <li>{@linkplain NucleusError#NULL_PLAN_CONSUMER} if the consumer is
* null</li>
* </ul>
*
* @throws ContractException
* <ul>
* <li>{@linkplain NucleusError#NULL_PLAN_CONSUMER} if
* the consumer is null</li>
* </ul>
*/
public ConsumerDataManagerPlan(double time, boolean active, Consumer<DataManagerContext> consumer) {
super(time, active);
Expand All @@ -53,12 +51,11 @@ public ConsumerDataManagerPlan(double time, boolean active, Consumer<DataManager
* be active.The arrival id is set to -1L indicating that this is a new,
* non-deserialized plan.
*
* @throw {@link ContractException}
* <ul>
* <li>{@linkplain NucleusError#NULL_PLAN_CONSUMER} if the consumer is
* null</li>
* </ul>
*
* @throws ContractException
* <ul>
* <li>{@linkplain NucleusError#NULL_PLAN_CONSUMER} if
* the consumer is null</li>
* </ul>
*/
public ConsumerDataManagerPlan(double time, Consumer<DataManagerContext> consumer) {
super(time);
Expand Down
26 changes: 12 additions & 14 deletions simulation/src/main/java/gov/hhs/aspr/ms/gcm/simulation/nucleus/ConsumerReportPlan.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,18 @@
import gov.hhs.aspr.ms.util.errors.ContractException;

public class ConsumerReportPlan extends ReportPlan {

private final Consumer<ReportContext> consumer;

/**
* Constructs the plan scheduled for the given time, arrivalId and consumer.
* Report plans are always passive.
*
* @throw {@link ContractException}
* <ul>
* <li>{@linkplain NucleusError#NULL_PLAN_CONSUMER} if the consumer is
* null</li>
* </ul>
*
* @throws ContractException
* <ul>
* <li>{@linkplain NucleusError#NULL_PLAN_CONSUMER} if
* the consumer is null</li>
* </ul>
*/
public ConsumerReportPlan(double time, long arrivalId, Consumer<ReportContext> consumer) {
super(time, arrivalId);
Expand All @@ -32,12 +31,11 @@ public ConsumerReportPlan(double time, long arrivalId, Consumer<ReportContext> c
* are always passive.The arrival id is set to -1L indicating that this is a
* new, non-deserialized plan.
*
* @throw {@link ContractException}
* <ul>
* <li>{@linkplain NucleusError#NULL_PLAN_CONSUMER} if the consumer is
* null</li>
* </ul>
*
* @throws ContractException
* <ul>
* <li>{@linkplain NucleusError#NULL_PLAN_CONSUMER} if
* the consumer is null</li>
* </ul>
*/
public ConsumerReportPlan(double time, Consumer<ReportContext> consumer) {
super(time);
Expand All @@ -48,7 +46,7 @@ public ConsumerReportPlan(double time, Consumer<ReportContext> consumer) {
}

@Override
protected void execute(ReportContext context) {
protected void execute(ReportContext context) {
this.consumer.accept(context);
}
}

0 comments on commit 07c0389

Please sign in to comment.