Skip to content

Add dots to each sentence #428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ppkarwasz merged 1 commit into from
May 12, 2026
Merged

Add dots to each sentence #428

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildDefinition.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ public BuildDefinition() {
/**
* Creates a new BuildDefinition with the given build type and external parameters.
*
* @param buildType URI indicating what type of build was performed
* @param externalParameters inputs passed to the build
* @param buildType URI indicating what type of build was performed.
* @param externalParameters inputs passed to the build.
*/
public BuildDefinition(String buildType, Map<String, Object> externalParameters) {
this.buildType = buildType;
Expand All @@ -93,7 +93,7 @@ public boolean equals(Object o) {
*
* <p>Determines the meaning of {@code externalParameters} and {@code internalParameters}.</p>
*
* @return the build type URI
* @return the build type URI.
*/
public String getBuildType() {
return buildType;
Expand All @@ -102,7 +102,7 @@ public String getBuildType() {
/**
* Gets the inputs passed to the build, such as command-line arguments or environment variables.
*
* @return the external parameters map, or {@code null} if not set
* @return the external parameters map, or {@code null} if not set.
*/
public Map<String, Object> getExternalParameters() {
return externalParameters;
Expand All @@ -112,7 +112,7 @@ public Map<String, Object> getExternalParameters() {
* Gets the artifacts the build depends on, such as sources, dependencies, build tools, and base images,
* specified by URI and digest.
*
* @return the internal parameters map, or {@code null} if not set
* @return the internal parameters map, or {@code null} if not set.
*/
public Map<String, Object> getInternalParameters() {
return internalParameters;
Expand All @@ -123,7 +123,7 @@ public Map<String, Object> getInternalParameters() {
*
* <p>Considered incomplete unless resolved materials are present.</p>
*
* @return the list of resolved dependencies, or {@code null} if not set
* @return the list of resolved dependencies, or {@code null} if not set.
*/
public List<ResourceDescriptor> getResolvedDependencies() {
return resolvedDependencies;
Expand All @@ -137,8 +137,8 @@ public int hashCode() {
/**
* Sets the URI indicating what type of build was performed.
*
* @param buildType the build type URI
* @return this for chaining
* @param buildType the build type URI.
* @return this for chaining.
*/
public BuildDefinition setBuildType(String buildType) {
this.buildType = buildType;
Expand All @@ -148,8 +148,8 @@ public BuildDefinition setBuildType(String buildType) {
/**
* Sets the inputs passed to the build.
*
* @param externalParameters the external parameters map
* @return this for chaining
* @param externalParameters the external parameters map.
* @return this for chaining.
*/
public BuildDefinition setExternalParameters(Map<String, Object> externalParameters) {
this.externalParameters = externalParameters;
Expand All @@ -159,8 +159,8 @@ public BuildDefinition setExternalParameters(Map<String, Object> externalParamet
/**
* Sets the artifacts the build depends on.
*
* @param internalParameters the internal parameters map
* @return this for chaining
* @param internalParameters the internal parameters map.
* @return this for chaining.
*/
public BuildDefinition setInternalParameters(Map<String, Object> internalParameters) {
this.internalParameters = internalParameters;
Expand All @@ -170,8 +170,8 @@ public BuildDefinition setInternalParameters(Map<String, Object> internalParamet
/**
* Sets the materials that influenced the build.
*
* @param resolvedDependencies the list of resolved dependencies
* @return this for chaining
* @param resolvedDependencies the list of resolved dependencies.
* @return this for chaining.
*/
public BuildDefinition setResolvedDependencies(List<ResourceDescriptor> resolvedDependencies) {
this.resolvedDependencies = resolvedDependencies;
Expand Down
24 changes: 12 additions & 12 deletions src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildMetadata.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,9 @@ public BuildMetadata() {
/**
* Creates a new BuildMetadata instance with all fields set.
*
* @param invocationId identifier for this build invocation
* @param startedOn timestamp when the build started
* @param finishedOn timestamp when the build completed
* @param invocationId identifier for this build invocation.
* @param startedOn timestamp when the build started.
* @param finishedOn timestamp when the build completed.
*/
public BuildMetadata(String invocationId, OffsetDateTime startedOn, OffsetDateTime finishedOn) {
this.invocationId = invocationId;
Expand All @@ -73,7 +73,7 @@ public boolean equals(Object o) {
/**
* Gets the timestamp of when the build completed, serialized as RFC 3339 in UTC ({@code "Z"} suffix).
*
* @return the completion timestamp, or {@code null} if not set
* @return the completion timestamp, or {@code null} if not set.
*/
public OffsetDateTime getFinishedOn() {
return finishedOn;
Expand All @@ -82,7 +82,7 @@ public OffsetDateTime getFinishedOn() {
/**
* Gets the identifier for this build invocation.
*
* @return the invocation identifier, or {@code null} if not set
* @return the invocation identifier, or {@code null} if not set.
*/
public String getInvocationId() {
return invocationId;
Expand All @@ -91,7 +91,7 @@ public String getInvocationId() {
/**
* Gets the timestamp of when the build started, serialized as RFC 3339 in UTC ({@code "Z"} suffix).
*
* @return the start timestamp, or {@code null} if not set
* @return the start timestamp, or {@code null} if not set.
*/
public OffsetDateTime getStartedOn() {
return startedOn;
Expand All @@ -105,8 +105,8 @@ public int hashCode() {
/**
* Sets the timestamp of when the build completed.
*
* @param finishedOn the completion timestamp
* @return this for chaining
* @param finishedOn the completion timestamp.
* @return this for chaining.
*/
public BuildMetadata setFinishedOn(OffsetDateTime finishedOn) {
this.finishedOn = finishedOn;
Expand All @@ -116,8 +116,8 @@ public BuildMetadata setFinishedOn(OffsetDateTime finishedOn) {
/**
* Sets the identifier for this build invocation.
*
* @param invocationId the invocation identifier
* @return this for chaining
* @param invocationId the invocation identifier.
* @return this for chaining.
*/
public BuildMetadata setInvocationId(String invocationId) {
this.invocationId = invocationId;
Expand All @@ -127,8 +127,8 @@ public BuildMetadata setInvocationId(String invocationId) {
/**
* Sets the timestamp of when the build started.
*
* @param startedOn the start timestamp
* @return this for chaining
* @param startedOn the start timestamp.
* @return this for chaining.
*/
public BuildMetadata setStartedOn(OffsetDateTime startedOn) {
this.startedOn = startedOn;
Expand Down
18 changes: 9 additions & 9 deletions src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Builder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public boolean equals(Object o) {
* Gets orchestrator dependencies that do not run within the build workload and do not affect the build output,
* but may affect provenance generation or security guarantees.
*
* @return the list of builder dependencies, or {@code null} if not set
* @return the list of builder dependencies, or {@code null} if not set.
*/
public List<ResourceDescriptor> getBuilderDependencies() {
return builderDependencies;
Expand All @@ -70,7 +70,7 @@ public List<ResourceDescriptor> getBuilderDependencies() {
/**
* Gets the identifier of the builder.
*
* @return the builder identifier URI
* @return the builder identifier URI.
*/
public String getId() {
return id;
Expand All @@ -79,7 +79,7 @@ public String getId() {
/**
* Gets a map of build platform component names to their versions.
*
* @return the version map, or {@code null} if not set
* @return the version map, or {@code null} if not set.
*/
public Map<String, String> getVersion() {
return version;
Expand All @@ -93,8 +93,8 @@ public int hashCode() {
/**
* Sets the orchestrator dependencies that may affect provenance generation or security guarantees.
*
* @param builderDependencies the list of builder dependencies
* @return this for chaining
* @param builderDependencies the list of builder dependencies.
* @return this for chaining.
*/
public Builder setBuilderDependencies(List<ResourceDescriptor> builderDependencies) {
this.builderDependencies = builderDependencies;
Expand All @@ -104,8 +104,8 @@ public Builder setBuilderDependencies(List<ResourceDescriptor> builderDependenci
/**
* Sets the identifier of the builder.
*
* @param id the builder identifier URI
* @return this for chaining
* @param id the builder identifier URI.
* @return this for chaining.
*/
public Builder setId(String id) {
this.id = id;
Expand All @@ -115,8 +115,8 @@ public Builder setId(String id) {
/**
* Sets the map of build platform component names to their versions.
*
* @param version the version map
* @return this for chaining
* @param version the version map.
* @return this for chaining.
*/
public Builder setVersion(Map<String, String> version) {
this.version = version;
Expand Down
18 changes: 9 additions & 9 deletions src/main/java/org/apache/commons/release/plugin/slsa/v1_2/DsseEnvelope.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public boolean equals(Object o) {
*
* <p>When serialized to JSON the bytes are Base64-encoded.</p>
*
* @return the payload bytes, or {@code null} if not set
* @return the payload bytes, or {@code null} if not set.
*/
public byte[] getPayload() {
return payload;
Expand All @@ -70,7 +70,7 @@ public byte[] getPayload() {
/**
* Gets the payload type URI.
*
* @return the payload type, never {@code null} in a valid envelope
* @return the payload type, never {@code null} in a valid envelope.
*/
public String getPayloadType() {
return payloadType;
Expand All @@ -79,7 +79,7 @@ public String getPayloadType() {
/**
* Gets the list of signatures over the PAE-encoded payload.
*
* @return the signatures, or {@code null} if not set
* @return the signatures, or {@code null} if not set.
*/
public List<Signature> getSignatures() {
return signatures;
Expand All @@ -93,8 +93,8 @@ public int hashCode() {
/**
* Sets the serialized payload bytes.
*
* @param payload the payload bytes
* @return this for chaining
* @param payload the payload bytes.
* @return this for chaining.
*/
public DsseEnvelope setPayload(byte[] payload) {
this.payload = payload;
Expand All @@ -104,8 +104,8 @@ public DsseEnvelope setPayload(byte[] payload) {
/**
* Sets the payload type URI.
*
* @param payloadType the payload type URI
* @return this for chaining
* @param payloadType the payload type URI.
* @return this for chaining.
*/
public DsseEnvelope setPayloadType(String payloadType) {
this.payloadType = payloadType;
Expand All @@ -115,8 +115,8 @@ public DsseEnvelope setPayloadType(String payloadType) {
/**
* Sets the list of signatures over the PAE-encoded payload.
*
* @param signatures the signatures
* @return this for chaining
* @param signatures the signatures.
* @return this for chaining.
*/
public DsseEnvelope setSignatures(List<Signature> signatures) {
this.signatures = signatures;
Expand Down
16 changes: 8 additions & 8 deletions src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Provenance.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ public Provenance() {
/**
* Creates a new Provenance with the given build definition and run details.
*
* @param buildDefinition inputs that defined the build
* @param runDetails details about the build invocation
* @param buildDefinition inputs that defined the build.
* @param runDetails details about the build invocation.
*/
public Provenance(BuildDefinition buildDefinition, RunDetails runDetails) {
this.buildDefinition = buildDefinition;
Expand All @@ -76,7 +76,7 @@ public boolean equals(Object o) {
*
* <p>Includes source code, dependencies, build tools, base images, and other materials.</p>
*
* @return the build definition, or {@code null} if not set
* @return the build definition, or {@code null} if not set.
*/
public BuildDefinition getBuildDefinition() {
return buildDefinition;
Expand All @@ -85,7 +85,7 @@ public BuildDefinition getBuildDefinition() {
/**
* Gets the details about the invocation of the build tool and the environment in which it was run.
*
* @return the run details, or {@code null} if not set
* @return the run details, or {@code null} if not set.
*/
public RunDetails getRunDetails() {
return runDetails;
Expand All @@ -99,8 +99,8 @@ public int hashCode() {
/**
* Sets the build definition describing all inputs that produced the build output.
*
* @param buildDefinition the build definition
* @return this for chaining
* @param buildDefinition the build definition.
* @return this for chaining.
*/
public Provenance setBuildDefinition(BuildDefinition buildDefinition) {
this.buildDefinition = buildDefinition;
Expand All @@ -110,8 +110,8 @@ public Provenance setBuildDefinition(BuildDefinition buildDefinition) {
/**
* Sets the details about the invocation of the build tool and the environment in which it was run.
*
* @param runDetails the run details
* @return this for chaining
* @param runDetails the run details.
* @return this for chaining.
*/
public Provenance setRunDetails(RunDetails runDetails) {
this.runDetails = runDetails;
Expand Down
Loading
Loading