software.amazon.awssdk.services.macie2.model.Page Maven / Gradle / Ivy
/*
* 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.macie2.model;
import java.io.Serializable;
import java.util.Arrays;
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.Consumer;
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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Specifies the location of an occurrence of sensitive data in an Adobe Portable Document Format file.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Page implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField LINE_RANGE_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("lineRange").getter(getter(Page::lineRange)).setter(setter(Builder::lineRange))
.constructor(Range::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("lineRange").build()).build();
private static final SdkField OFFSET_RANGE_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("offsetRange").getter(getter(Page::offsetRange)).setter(setter(Builder::offsetRange))
.constructor(Range::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("offsetRange").build()).build();
private static final SdkField PAGE_NUMBER_FIELD = SdkField. builder(MarshallingType.LONG)
.memberName("pageNumber").getter(getter(Page::pageNumber)).setter(setter(Builder::pageNumber))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("pageNumber").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(LINE_RANGE_FIELD,
OFFSET_RANGE_FIELD, PAGE_NUMBER_FIELD));
private static final long serialVersionUID = 1L;
private final Range lineRange;
private final Range offsetRange;
private final Long pageNumber;
private Page(BuilderImpl builder) {
this.lineRange = builder.lineRange;
this.offsetRange = builder.offsetRange;
this.pageNumber = builder.pageNumber;
}
/**
*
* Reserved for future use.
*
*
* @return
* Reserved for future use.
*
*/
public final Range lineRange() {
return lineRange;
}
/**
*
* Reserved for future use.
*
*
* @return
* Reserved for future use.
*
*/
public final Range offsetRange() {
return offsetRange;
}
/**
*
* The page number of the page that contains the sensitive data.
*
*
* @return The page number of the page that contains the sensitive data.
*/
public final Long pageNumber() {
return pageNumber;
}
@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(lineRange());
hashCode = 31 * hashCode + Objects.hashCode(offsetRange());
hashCode = 31 * hashCode + Objects.hashCode(pageNumber());
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 Page)) {
return false;
}
Page other = (Page) obj;
return Objects.equals(lineRange(), other.lineRange()) && Objects.equals(offsetRange(), other.offsetRange())
&& Objects.equals(pageNumber(), other.pageNumber());
}
/**
* 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("Page").add("LineRange", lineRange()).add("OffsetRange", offsetRange())
.add("PageNumber", pageNumber()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "lineRange":
return Optional.ofNullable(clazz.cast(lineRange()));
case "offsetRange":
return Optional.ofNullable(clazz.cast(offsetRange()));
case "pageNumber":
return Optional.ofNullable(clazz.cast(pageNumber()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Page) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Reserved for future use.
*
*
* @param lineRange
*
* Reserved for future use.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lineRange(Range lineRange);
/**
*
* Reserved for future use.
*
* This is a convenience method that creates an instance of the {@link Range.Builder} avoiding the need to
* create one manually via {@link Range#builder()}.
*
*
* When the {@link Consumer} completes, {@link Range.Builder#build()} is called immediately and its result is
* passed to {@link #lineRange(Range)}.
*
* @param lineRange
* a consumer that will call methods on {@link Range.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #lineRange(Range)
*/
default Builder lineRange(Consumer lineRange) {
return lineRange(Range.builder().applyMutation(lineRange).build());
}
/**
*
* Reserved for future use.
*
*
* @param offsetRange
*
* Reserved for future use.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder offsetRange(Range offsetRange);
/**
*
* Reserved for future use.
*
* This is a convenience method that creates an instance of the {@link Range.Builder} avoiding the need to
* create one manually via {@link Range#builder()}.
*
*
* When the {@link Consumer} completes, {@link Range.Builder#build()} is called immediately and its result is
* passed to {@link #offsetRange(Range)}.
*
* @param offsetRange
* a consumer that will call methods on {@link Range.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #offsetRange(Range)
*/
default Builder offsetRange(Consumer offsetRange) {
return offsetRange(Range.builder().applyMutation(offsetRange).build());
}
/**
*
* The page number of the page that contains the sensitive data.
*
*
* @param pageNumber
* The page number of the page that contains the sensitive data.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder pageNumber(Long pageNumber);
}
static final class BuilderImpl implements Builder {
private Range lineRange;
private Range offsetRange;
private Long pageNumber;
private BuilderImpl() {
}
private BuilderImpl(Page model) {
lineRange(model.lineRange);
offsetRange(model.offsetRange);
pageNumber(model.pageNumber);
}
public final Range.Builder getLineRange() {
return lineRange != null ? lineRange.toBuilder() : null;
}
public final void setLineRange(Range.BuilderImpl lineRange) {
this.lineRange = lineRange != null ? lineRange.build() : null;
}
@Override
public final Builder lineRange(Range lineRange) {
this.lineRange = lineRange;
return this;
}
public final Range.Builder getOffsetRange() {
return offsetRange != null ? offsetRange.toBuilder() : null;
}
public final void setOffsetRange(Range.BuilderImpl offsetRange) {
this.offsetRange = offsetRange != null ? offsetRange.build() : null;
}
@Override
public final Builder offsetRange(Range offsetRange) {
this.offsetRange = offsetRange;
return this;
}
public final Long getPageNumber() {
return pageNumber;
}
public final void setPageNumber(Long pageNumber) {
this.pageNumber = pageNumber;
}
@Override
public final Builder pageNumber(Long pageNumber) {
this.pageNumber = pageNumber;
return this;
}
@Override
public Page build() {
return new Page(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}