com.amazonaws.services.codegurureviewer.model.Metrics Maven / Gradle / Ivy
Show all versions of aws-java-sdk-codegurureviewer Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.codegurureviewer.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Information about the statistics from the code review.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Metrics implements Serializable, Cloneable, StructuredPojo {
/**
*
* MeteredLinesOfCodeCount
is the number of lines of code in the repository where the code review
* happened. This does not include non-code lines such as comments and blank lines.
*
*/
private Long meteredLinesOfCodeCount;
/**
*
* SuppressedLinesOfCodeCount
is the number of lines of code in the repository where the code review
* happened that CodeGuru Reviewer did not analyze. The lines suppressed in the analysis is based on the
* excludeFiles
variable in the aws-codeguru-reviewer.yml
file. This number does not
* include non-code lines such as comments and blank lines.
*
*/
private Long suppressedLinesOfCodeCount;
/**
*
* Total number of recommendations found in the code review.
*
*/
private Long findingsCount;
/**
*
* MeteredLinesOfCodeCount
is the number of lines of code in the repository where the code review
* happened. This does not include non-code lines such as comments and blank lines.
*
*
* @param meteredLinesOfCodeCount
* MeteredLinesOfCodeCount
is the number of lines of code in the repository where the code
* review happened. This does not include non-code lines such as comments and blank lines.
*/
public void setMeteredLinesOfCodeCount(Long meteredLinesOfCodeCount) {
this.meteredLinesOfCodeCount = meteredLinesOfCodeCount;
}
/**
*
* MeteredLinesOfCodeCount
is the number of lines of code in the repository where the code review
* happened. This does not include non-code lines such as comments and blank lines.
*
*
* @return MeteredLinesOfCodeCount
is the number of lines of code in the repository where the code
* review happened. This does not include non-code lines such as comments and blank lines.
*/
public Long getMeteredLinesOfCodeCount() {
return this.meteredLinesOfCodeCount;
}
/**
*
* MeteredLinesOfCodeCount
is the number of lines of code in the repository where the code review
* happened. This does not include non-code lines such as comments and blank lines.
*
*
* @param meteredLinesOfCodeCount
* MeteredLinesOfCodeCount
is the number of lines of code in the repository where the code
* review happened. This does not include non-code lines such as comments and blank lines.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Metrics withMeteredLinesOfCodeCount(Long meteredLinesOfCodeCount) {
setMeteredLinesOfCodeCount(meteredLinesOfCodeCount);
return this;
}
/**
*
* SuppressedLinesOfCodeCount
is the number of lines of code in the repository where the code review
* happened that CodeGuru Reviewer did not analyze. The lines suppressed in the analysis is based on the
* excludeFiles
variable in the aws-codeguru-reviewer.yml
file. This number does not
* include non-code lines such as comments and blank lines.
*
*
* @param suppressedLinesOfCodeCount
* SuppressedLinesOfCodeCount
is the number of lines of code in the repository where the code
* review happened that CodeGuru Reviewer did not analyze. The lines suppressed in the analysis is based on
* the excludeFiles
variable in the aws-codeguru-reviewer.yml
file. This number
* does not include non-code lines such as comments and blank lines.
*/
public void setSuppressedLinesOfCodeCount(Long suppressedLinesOfCodeCount) {
this.suppressedLinesOfCodeCount = suppressedLinesOfCodeCount;
}
/**
*
* SuppressedLinesOfCodeCount
is the number of lines of code in the repository where the code review
* happened that CodeGuru Reviewer did not analyze. The lines suppressed in the analysis is based on the
* excludeFiles
variable in the aws-codeguru-reviewer.yml
file. This number does not
* include non-code lines such as comments and blank lines.
*
*
* @return SuppressedLinesOfCodeCount
is the number of lines of code in the repository where the code
* review happened that CodeGuru Reviewer did not analyze. The lines suppressed in the analysis is based on
* the excludeFiles
variable in the aws-codeguru-reviewer.yml
file. This number
* does not include non-code lines such as comments and blank lines.
*/
public Long getSuppressedLinesOfCodeCount() {
return this.suppressedLinesOfCodeCount;
}
/**
*
* SuppressedLinesOfCodeCount
is the number of lines of code in the repository where the code review
* happened that CodeGuru Reviewer did not analyze. The lines suppressed in the analysis is based on the
* excludeFiles
variable in the aws-codeguru-reviewer.yml
file. This number does not
* include non-code lines such as comments and blank lines.
*
*
* @param suppressedLinesOfCodeCount
* SuppressedLinesOfCodeCount
is the number of lines of code in the repository where the code
* review happened that CodeGuru Reviewer did not analyze. The lines suppressed in the analysis is based on
* the excludeFiles
variable in the aws-codeguru-reviewer.yml
file. This number
* does not include non-code lines such as comments and blank lines.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Metrics withSuppressedLinesOfCodeCount(Long suppressedLinesOfCodeCount) {
setSuppressedLinesOfCodeCount(suppressedLinesOfCodeCount);
return this;
}
/**
*
* Total number of recommendations found in the code review.
*
*
* @param findingsCount
* Total number of recommendations found in the code review.
*/
public void setFindingsCount(Long findingsCount) {
this.findingsCount = findingsCount;
}
/**
*
* Total number of recommendations found in the code review.
*
*
* @return Total number of recommendations found in the code review.
*/
public Long getFindingsCount() {
return this.findingsCount;
}
/**
*
* Total number of recommendations found in the code review.
*
*
* @param findingsCount
* Total number of recommendations found in the code review.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Metrics withFindingsCount(Long findingsCount) {
setFindingsCount(findingsCount);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getMeteredLinesOfCodeCount() != null)
sb.append("MeteredLinesOfCodeCount: ").append(getMeteredLinesOfCodeCount()).append(",");
if (getSuppressedLinesOfCodeCount() != null)
sb.append("SuppressedLinesOfCodeCount: ").append(getSuppressedLinesOfCodeCount()).append(",");
if (getFindingsCount() != null)
sb.append("FindingsCount: ").append(getFindingsCount());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Metrics == false)
return false;
Metrics other = (Metrics) obj;
if (other.getMeteredLinesOfCodeCount() == null ^ this.getMeteredLinesOfCodeCount() == null)
return false;
if (other.getMeteredLinesOfCodeCount() != null && other.getMeteredLinesOfCodeCount().equals(this.getMeteredLinesOfCodeCount()) == false)
return false;
if (other.getSuppressedLinesOfCodeCount() == null ^ this.getSuppressedLinesOfCodeCount() == null)
return false;
if (other.getSuppressedLinesOfCodeCount() != null && other.getSuppressedLinesOfCodeCount().equals(this.getSuppressedLinesOfCodeCount()) == false)
return false;
if (other.getFindingsCount() == null ^ this.getFindingsCount() == null)
return false;
if (other.getFindingsCount() != null && other.getFindingsCount().equals(this.getFindingsCount()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getMeteredLinesOfCodeCount() == null) ? 0 : getMeteredLinesOfCodeCount().hashCode());
hashCode = prime * hashCode + ((getSuppressedLinesOfCodeCount() == null) ? 0 : getSuppressedLinesOfCodeCount().hashCode());
hashCode = prime * hashCode + ((getFindingsCount() == null) ? 0 : getFindingsCount().hashCode());
return hashCode;
}
@Override
public Metrics clone() {
try {
return (Metrics) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.codegurureviewer.model.transform.MetricsMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}