Skip to content

Commit 8e0d7b6

Browse files
committed
more javadoc comments.
1 parent bec048d commit 8e0d7b6

File tree

3 files changed

+67
-6
lines changed

3 files changed

+67
-6
lines changed

library/src/main/java/io/syslogic/github/api/model/WorkflowJobsResponse.java

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,41 @@
1515
public class WorkflowJobsResponse {
1616
@SerializedName("total_count")
1717
private Long totalCount = 0L;
18+
1819
@SerializedName("jobs")
1920
private ArrayList<WorkflowJob> jobs;
2021

22+
/**
23+
* Setter for totalCount.
24+
* @param value the total count of workflow jobs.
25+
*/
2126
@SuppressWarnings("unused")
2227
public void setTotalCount(@NonNull Long value) {
2328
this.totalCount = value;
2429
}
30+
31+
/**
32+
* Setter for workflow jobs.
33+
* @param items the workflow jobs.
34+
*/
2535
@SuppressWarnings("unused")
26-
public void setJobs(@NonNull ArrayList<WorkflowJob> value) {
27-
this.jobs = value;
36+
public void setJobs(@NonNull ArrayList<WorkflowJob> items) {
37+
this.jobs = items;
2838
}
39+
40+
/**
41+
* Getter for totalCount.
42+
* @return the total count of workflow jobs.
43+
*/
2944
@NonNull
3045
public Long getTotalCount() {
3146
return this.totalCount;
3247
}
48+
49+
/**
50+
* Getter for workflow jobs.
51+
* @return the workflow jobs.
52+
*/
3353
@Nullable
3454
public ArrayList<WorkflowJob> getJobs() {
3555
return this.jobs;

library/src/main/java/io/syslogic/github/api/model/WorkflowRun.java

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,88 +23,109 @@
2323
@Entity(tableName = Constants.TABLE_WORKFLOW_RUNS)
2424
public class WorkflowRun extends BaseModel implements IContentProvider {
2525

26+
/** ID */
2627
@PrimaryKey()
2728
@ColumnInfo(name = "id")
2829
@SerializedName("id")
2930
private long id;
3031

32+
/** WorkflowId */
3133
// foreign key
3234
@ColumnInfo(name = "workflow_id")
3335
@SerializedName("workflow_id")
3436
private long workflowId;
3537

38+
/** RunNumber */
3639
@ColumnInfo(name = "run_number")
3740
@SerializedName("run_number")
3841
private long runNumber;
3942

43+
/** CheckSuiteId */
4044
@ColumnInfo(name = "check_suite_id")
4145
@SerializedName("check_suite_id")
4246
private long checkSuiteId;
4347

48+
/** CheckSuiteNodeId */
4449
@ColumnInfo(name = "check_suite_node_id")
4550
@SerializedName("check_suite_node_id")
4651
private String checkSuiteNodeId;
4752

53+
/** NodeId */
4854
@ColumnInfo(name = "node_id")
4955
@SerializedName("node_id")
5056
private String nodeId;
5157

58+
/** Event */
5259
@ColumnInfo(name = "event")
5360
@SerializedName("event")
5461
private String event;
5562

63+
/** Status */
5664
@ColumnInfo(name = "status")
5765
@SerializedName("status")
5866
private String status;
5967

68+
/** Conclusion */
6069
@ColumnInfo(name = "conclusion")
6170
@SerializedName("conclusion")
6271
private String conclusion;
6372

73+
/** Name */
6474
@ColumnInfo(name = "name")
6575
@SerializedName("name")
6676
private String name;
6777

78+
/** HeadBranch */
6879
@ColumnInfo(name = "head_branch")
6980
@SerializedName("head_branch")
7081
private String headBranch;
7182

83+
/** HeadSha */
7284
@ColumnInfo(name = "head_sha")
7385
@SerializedName("head_sha")
7486
private String headSha;
7587

88+
/** DisplayTitle */
7689
@ColumnInfo(name = "display_title")
7790
@SerializedName("display_title")
7891
private String displayTitle;
7992

93+
/** Url */
8094
@ColumnInfo(name = "url")
8195
@SerializedName("url")
8296
private String url;
8397

98+
/** HtmlUrl */
8499
@ColumnInfo(name = "html_url")
85100
@SerializedName("html_url")
86101
private String htmlUrl;
87102

103+
/** CreatedAt */
88104
@ColumnInfo(name = "created_at")
89105
@SerializedName("created_at")
90106
private Date createdAt;
91107

108+
/** UpdatedAt */
92109
@ColumnInfo(name = "updated_at")
93110
@SerializedName("updated_at")
94111
private Date updatedAt;
95112

113+
/** Actor */
96114
@Ignore
97115
@SerializedName("actor")
98116
private User actor;
99117

118+
/** TriggeringActor */
100119
@Ignore
101120
@SerializedName("triggering_actor")
102121
private User triggeringActor;
103122

123+
/** RunStartedAt */
104124
@ColumnInfo(name = "run_started_at")
105125
@SerializedName("run_started_at")
106126
private Date runStartedAt;
107127

128+
/** RunAttempt */
108129
@ColumnInfo(name = "run_attempt")
109130
@SerializedName("run_attempt")
110131
private long runAttempt;

library/src/main/java/io/syslogic/github/api/model/WorkflowRunsResponse.java

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,43 @@
1313
* @author Martin Zeitler
1414
*/
1515
public class WorkflowRunsResponse {
16-
@SerializedName("total_count")
17-
private Long totalCount = 0L;
16+
1817
@SerializedName("workflow_runs")
1918
private ArrayList<WorkflowRun> workflowRuns;
2019

20+
@SerializedName("total_count")
21+
private Long totalCount = 0L;
22+
23+
/**
24+
* Setter for totalCount.
25+
* @param value the total count of workflow runs.
26+
*/
2127
@SuppressWarnings("unused")
2228
public void setTotalCount(@NonNull Long value) {
2329
this.totalCount = value;
2430
}
25-
public void setWorkflowRuns(@NonNull ArrayList<WorkflowRun> value) {
26-
this.workflowRuns = value;
31+
32+
/**
33+
* Setter for workflow runs.
34+
* @param items the workflows.
35+
*/
36+
public void setWorkflowRuns(@NonNull ArrayList<WorkflowRun> items) {
37+
this.workflowRuns = items;
2738
}
39+
40+
/**
41+
* Getter for totalCount.
42+
* @return the total count of workflows.
43+
*/
2844
@NonNull
2945
public Long getTotalCount() {
3046
return this.totalCount;
3147
}
3248

49+
/**
50+
* Getter for workflow runs.
51+
* @return the workflow runs.
52+
*/
3353
@Nullable
3454
public ArrayList<WorkflowRun> getWorkflowRuns() {
3555
return this.workflowRuns;

0 commit comments

Comments
 (0)