software.amazon.awssdk.services.codegurureviewer.model.RuleMetadata Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of codegurureviewer Show documentation
Show all versions of codegurureviewer Show documentation
The AWS Java SDK for CodeGuru Reviewer module holds the client classes that are used for
communicating with CodeGuru Reviewer.
/*
* Copyright 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 software.amazon.awssdk.services.codegurureviewer.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Metadata about a rule. Rule metadata includes an ID, a name, a list of tags, and a short and long description.
* CodeGuru Reviewer uses rules to analyze code. A rule's recommendation is included in analysis results if code is
* detected that violates the rule.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class RuleMetadata implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField RULE_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("RuleId")
.getter(getter(RuleMetadata::ruleId)).setter(setter(Builder::ruleId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RuleId").build()).build();
private static final SdkField RULE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RuleName").getter(getter(RuleMetadata::ruleName)).setter(setter(Builder::ruleName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RuleName").build()).build();
private static final SdkField SHORT_DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ShortDescription").getter(getter(RuleMetadata::shortDescription))
.setter(setter(Builder::shortDescription))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ShortDescription").build()).build();
private static final SdkField LONG_DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("LongDescription").getter(getter(RuleMetadata::longDescription)).setter(setter(Builder::longDescription))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LongDescription").build()).build();
private static final SdkField> RULE_TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("RuleTags")
.getter(getter(RuleMetadata::ruleTags))
.setter(setter(Builder::ruleTags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RuleTags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(RULE_ID_FIELD,
RULE_NAME_FIELD, SHORT_DESCRIPTION_FIELD, LONG_DESCRIPTION_FIELD, RULE_TAGS_FIELD));
private static final long serialVersionUID = 1L;
private final String ruleId;
private final String ruleName;
private final String shortDescription;
private final String longDescription;
private final List ruleTags;
private RuleMetadata(BuilderImpl builder) {
this.ruleId = builder.ruleId;
this.ruleName = builder.ruleName;
this.shortDescription = builder.shortDescription;
this.longDescription = builder.longDescription;
this.ruleTags = builder.ruleTags;
}
/**
*
* The ID of the rule.
*
*
* @return The ID of the rule.
*/
public final String ruleId() {
return ruleId;
}
/**
*
* The name of the rule.
*
*
* @return The name of the rule.
*/
public final String ruleName() {
return ruleName;
}
/**
*
* A short description of the rule.
*
*
* @return A short description of the rule.
*/
public final String shortDescription() {
return shortDescription;
}
/**
*
* A long description of the rule.
*
*
* @return A long description of the rule.
*/
public final String longDescription() {
return longDescription;
}
/**
* For responses, this returns true if the service returned a value for the RuleTags property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is
* useful because the SDK will never return a null collection or map, but you may need to differentiate between the
* service returning nothing (or null) and the service returning an empty collection or map. For requests, this
* returns true if a value for the property was specified in the request builder, and false if a value was not
* specified.
*/
public final boolean hasRuleTags() {
return ruleTags != null && !(ruleTags instanceof SdkAutoConstructList);
}
/**
*
* Tags that are associated with the rule.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasRuleTags} method.
*
*
* @return Tags that are associated with the rule.
*/
public final List ruleTags() {
return ruleTags;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(ruleId());
hashCode = 31 * hashCode + Objects.hashCode(ruleName());
hashCode = 31 * hashCode + Objects.hashCode(shortDescription());
hashCode = 31 * hashCode + Objects.hashCode(longDescription());
hashCode = 31 * hashCode + Objects.hashCode(hasRuleTags() ? ruleTags() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof RuleMetadata)) {
return false;
}
RuleMetadata other = (RuleMetadata) obj;
return Objects.equals(ruleId(), other.ruleId()) && Objects.equals(ruleName(), other.ruleName())
&& Objects.equals(shortDescription(), other.shortDescription())
&& Objects.equals(longDescription(), other.longDescription()) && hasRuleTags() == other.hasRuleTags()
&& Objects.equals(ruleTags(), other.ruleTags());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("RuleMetadata").add("RuleId", ruleId()).add("RuleName", ruleName())
.add("ShortDescription", shortDescription()).add("LongDescription", longDescription())
.add("RuleTags", hasRuleTags() ? ruleTags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "RuleId":
return Optional.ofNullable(clazz.cast(ruleId()));
case "RuleName":
return Optional.ofNullable(clazz.cast(ruleName()));
case "ShortDescription":
return Optional.ofNullable(clazz.cast(shortDescription()));
case "LongDescription":
return Optional.ofNullable(clazz.cast(longDescription()));
case "RuleTags":
return Optional.ofNullable(clazz.cast(ruleTags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((RuleMetadata) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The ID of the rule.
*
*
* @param ruleId
* The ID of the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ruleId(String ruleId);
/**
*
* The name of the rule.
*
*
* @param ruleName
* The name of the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ruleName(String ruleName);
/**
*
* A short description of the rule.
*
*
* @param shortDescription
* A short description of the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder shortDescription(String shortDescription);
/**
*
* A long description of the rule.
*
*
* @param longDescription
* A long description of the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder longDescription(String longDescription);
/**
*
* Tags that are associated with the rule.
*
*
* @param ruleTags
* Tags that are associated with the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ruleTags(Collection ruleTags);
/**
*
* Tags that are associated with the rule.
*
*
* @param ruleTags
* Tags that are associated with the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ruleTags(String... ruleTags);
}
static final class BuilderImpl implements Builder {
private String ruleId;
private String ruleName;
private String shortDescription;
private String longDescription;
private List ruleTags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(RuleMetadata model) {
ruleId(model.ruleId);
ruleName(model.ruleName);
shortDescription(model.shortDescription);
longDescription(model.longDescription);
ruleTags(model.ruleTags);
}
public final String getRuleId() {
return ruleId;
}
public final void setRuleId(String ruleId) {
this.ruleId = ruleId;
}
@Override
public final Builder ruleId(String ruleId) {
this.ruleId = ruleId;
return this;
}
public final String getRuleName() {
return ruleName;
}
public final void setRuleName(String ruleName) {
this.ruleName = ruleName;
}
@Override
public final Builder ruleName(String ruleName) {
this.ruleName = ruleName;
return this;
}
public final String getShortDescription() {
return shortDescription;
}
public final void setShortDescription(String shortDescription) {
this.shortDescription = shortDescription;
}
@Override
public final Builder shortDescription(String shortDescription) {
this.shortDescription = shortDescription;
return this;
}
public final String getLongDescription() {
return longDescription;
}
public final void setLongDescription(String longDescription) {
this.longDescription = longDescription;
}
@Override
public final Builder longDescription(String longDescription) {
this.longDescription = longDescription;
return this;
}
public final Collection getRuleTags() {
if (ruleTags instanceof SdkAutoConstructList) {
return null;
}
return ruleTags;
}
public final void setRuleTags(Collection ruleTags) {
this.ruleTags = RuleTagsCopier.copy(ruleTags);
}
@Override
public final Builder ruleTags(Collection ruleTags) {
this.ruleTags = RuleTagsCopier.copy(ruleTags);
return this;
}
@Override
@SafeVarargs
public final Builder ruleTags(String... ruleTags) {
ruleTags(Arrays.asList(ruleTags));
return this;
}
@Override
public RuleMetadata build() {
return new RuleMetadata(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy