software.amazon.awssdk.services.wisdom.model.Highlight Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wisdom Show documentation
The AWS Java SDK for Wisdom module holds the client classes that are used for communicating with Wisdom.
There is a newer version: 2.29.15
/*
 * 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.wisdom.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.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;

/**
 * 
 * Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class Highlight implements SdkPojo, Serializable, ToCopyableBuilder {
    private static final SdkField BEGIN_OFFSET_INCLUSIVE_FIELD = SdkField. builder(MarshallingType.INTEGER)
            .memberName("beginOffsetInclusive").getter(getter(Highlight::beginOffsetInclusive))
            .setter(setter(Builder::beginOffsetInclusive))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("beginOffsetInclusive").build())
            .build();

    private static final SdkField END_OFFSET_EXCLUSIVE_FIELD = SdkField. builder(MarshallingType.INTEGER)
            .memberName("endOffsetExclusive").getter(getter(Highlight::endOffsetExclusive))
            .setter(setter(Builder::endOffsetExclusive))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("endOffsetExclusive").build())
            .build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(BEGIN_OFFSET_INCLUSIVE_FIELD,
            END_OFFSET_EXCLUSIVE_FIELD));

    private static final long serialVersionUID = 1L;

    private final Integer beginOffsetInclusive;

    private final Integer endOffsetExclusive;

    private Highlight(BuilderImpl builder) {
        this.beginOffsetInclusive = builder.beginOffsetInclusive;
        this.endOffsetExclusive = builder.endOffsetExclusive;
    }

    /**
     * 
     * The offset for the start of the highlight.
     * 
     * 
     * @return The offset for the start of the highlight.
     */
    public final Integer beginOffsetInclusive() {
        return beginOffsetInclusive;
    }

    /**
     * 
     * The offset for the end of the highlight.
     * 
     * 
     * @return The offset for the end of the highlight.
     */
    public final Integer endOffsetExclusive() {
        return endOffsetExclusive;
    }

    @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(beginOffsetInclusive());
        hashCode = 31 * hashCode + Objects.hashCode(endOffsetExclusive());
        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 Highlight)) {
            return false;
        }
        Highlight other = (Highlight) obj;
        return Objects.equals(beginOffsetInclusive(), other.beginOffsetInclusive())
                && Objects.equals(endOffsetExclusive(), other.endOffsetExclusive());
    }

    /**
     * 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("Highlight").add("BeginOffsetInclusive", beginOffsetInclusive())
                .add("EndOffsetExclusive", endOffsetExclusive()).build();
    }

    public final  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "beginOffsetInclusive":
            return Optional.ofNullable(clazz.cast(beginOffsetInclusive()));
        case "endOffsetExclusive":
            return Optional.ofNullable(clazz.cast(endOffsetExclusive()));
        default:
            return Optional.empty();
        }
    }

    @Override
    public final List> sdkFields() {
        return SDK_FIELDS;
    }

    private static  Function getter(Function g) {
        return obj -> g.apply((Highlight) obj);
    }

    private static  BiConsumer setter(BiConsumer s) {
        return (obj, val) -> s.accept((Builder) obj, val);
    }

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 
         * The offset for the start of the highlight.
         * 
         * 
         * @param beginOffsetInclusive
         *        The offset for the start of the highlight.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder beginOffsetInclusive(Integer beginOffsetInclusive);

        /**
         * 
         * The offset for the end of the highlight.
         * 
         * 
         * @param endOffsetExclusive
         *        The offset for the end of the highlight.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder endOffsetExclusive(Integer endOffsetExclusive);
    }

    static final class BuilderImpl implements Builder {
        private Integer beginOffsetInclusive;

        private Integer endOffsetExclusive;

        private BuilderImpl() {
        }

        private BuilderImpl(Highlight model) {
            beginOffsetInclusive(model.beginOffsetInclusive);
            endOffsetExclusive(model.endOffsetExclusive);
        }

        public final Integer getBeginOffsetInclusive() {
            return beginOffsetInclusive;
        }

        public final void setBeginOffsetInclusive(Integer beginOffsetInclusive) {
            this.beginOffsetInclusive = beginOffsetInclusive;
        }

        @Override
        public final Builder beginOffsetInclusive(Integer beginOffsetInclusive) {
            this.beginOffsetInclusive = beginOffsetInclusive;
            return this;
        }

        public final Integer getEndOffsetExclusive() {
            return endOffsetExclusive;
        }

        public final void setEndOffsetExclusive(Integer endOffsetExclusive) {
            this.endOffsetExclusive = endOffsetExclusive;
        }

        @Override
        public final Builder endOffsetExclusive(Integer endOffsetExclusive) {
            this.endOffsetExclusive = endOffsetExclusive;
            return this;
        }

        @Override
        public Highlight build() {
            return new Highlight(this);
        }

        @Override
        public List> sdkFields() {
            return SDK_FIELDS;
        }
    }
}