jlengrand/github-api
1
0
Fork 0
mirror of https://github.com/jlengrand/github-api.git synced 2026-04-05 00:11:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added some Javadoc.

Browse Source
This commit is contained in:
Jesse Glick
2020-03-26 16:22:04 -04:00
parent 26b8082155
commit b5dc3c4366
2 changed files with 30 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
src/main/java/org/kohsuke/github/GHCheckRunBuilder.java
View File

@@ -102,10 +102,16 @@ public final class GHCheckRunBuilder {
return this;
}
/**
* Drafts the output section; use {@link DraftOutput#done} to continue.
*/
public @NonNull DraftOutput withOutput(@NonNull String title, @NonNull String summary) {
return new DraftOutput(this, title, summary);
}
/**
* Drafts an action section; use {@link DraftOutput#done} to continue.
*/
public @NonNull GHCheckRunBuilder withAction(@NonNull String label,
@NonNull String description,
@NonNull String identifier) {
@@ -117,6 +123,9 @@ public final class GHCheckRunBuilder {
}
private static final int MAX_ANNOTATIONS = 50;
/**
* Actually creates the check run. (If more than fifty annotations were requested, this is done in batches.)
*/
public @NonNull GHCheckRun create() throws IOException {
List<DraftAnnotation> extraAnnotations;
if (output != null && output.annotations.size() > MAX_ANNOTATIONS) {
@@ -163,6 +172,12 @@ public final class GHCheckRunBuilder {
return this;
}
/**
* Drafts a single-line annotation section; use {@link DraftAnnotation#done} to continue.
*
* @param line
* a single line
*/
public @NonNull DraftAnnotation withAnnotation(@NonNull String path,
int line,
@NonNull GHCheckRunAnnotationLevel annotationLevel,
@@ -170,6 +185,9 @@ public final class GHCheckRunBuilder {
return withAnnotation(path, line, line, annotationLevel, message);
}
/**
* Drafts a potentially multiline annotation section; use {@link DraftAnnotation#done} to continue.
*/
public @NonNull DraftAnnotation withAnnotation(@NonNull String path,
int startLine,
int endLine,
@@ -178,6 +196,9 @@ public final class GHCheckRunBuilder {
return new DraftAnnotation(this, path, startLine, endLine, annotationLevel, message);
}
/**
* Drafts an image section; use {@link DraftImage#done} to continue.
*/
public @NonNull DraftImage withImage(@NonNull String alt, @NonNull String imageURL) {
return new DraftImage(this, alt, imageURL);
}