software.amazon.awssdk.services.location.model.PlaceGeometry Maven / Gradle / Ivy
Show all versions of location Show documentation
/*
* 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.location.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;
/**
*
* Places uses a point geometry to specify a location or a Place.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class PlaceGeometry implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> POINT_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Point")
.getter(getter(PlaceGeometry::point))
.setter(setter(Builder::point))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Point").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.DOUBLE)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(POINT_FIELD));
private static final long serialVersionUID = 1L;
private final List point;
private PlaceGeometry(BuilderImpl builder) {
this.point = builder.point;
}
/**
* For responses, this returns true if the service returned a value for the Point 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 hasPoint() {
return point != null && !(point instanceof SdkAutoConstructList);
}
/**
*
* A single point geometry specifies a location for a Place using WGS 84 coordinates:
*
*
* -
*
* x — Specifies the x coordinate or longitude.
*
*
* -
*
* y — Specifies the y coordinate or latitude.
*
*
*
*
* 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 #hasPoint} method.
*
*
* @return A single point geometry specifies a location for a Place using WGS 84 coordinates:
*
* -
*
* x — Specifies the x coordinate or longitude.
*
*
* -
*
* y — Specifies the y coordinate or latitude.
*
*
*/
public final List point() {
return point;
}
@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(hasPoint() ? point() : 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 PlaceGeometry)) {
return false;
}
PlaceGeometry other = (PlaceGeometry) obj;
return hasPoint() == other.hasPoint() && Objects.equals(point(), other.point());
}
/**
* 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("PlaceGeometry").add("Point", point() == null ? null : "*** Sensitive Data Redacted ***").build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Point":
return Optional.ofNullable(clazz.cast(point()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PlaceGeometry) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A single point geometry specifies a location for a Place using WGS 84 coordinates:
*
*
* -
*
* x — Specifies the x coordinate or longitude.
*
*
* -
*
* y — Specifies the y coordinate or latitude.
*
*
*
*
* @param point
* A single point geometry specifies a location for a Place using WGS 84 coordinates:
*
* -
*
* x — Specifies the x coordinate or longitude.
*
*
* -
*
* y — Specifies the y coordinate or latitude.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder point(Collection point);
/**
*
* A single point geometry specifies a location for a Place using WGS 84 coordinates:
*
*
* -
*
* x — Specifies the x coordinate or longitude.
*
*
* -
*
* y — Specifies the y coordinate or latitude.
*
*
*
*
* @param point
* A single point geometry specifies a location for a Place using WGS 84 coordinates:
*
* -
*
* x — Specifies the x coordinate or longitude.
*
*
* -
*
* y — Specifies the y coordinate or latitude.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder point(Double... point);
}
static final class BuilderImpl implements Builder {
private List point = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(PlaceGeometry model) {
point(model.point);
}
public final Collection getPoint() {
if (point instanceof SdkAutoConstructList) {
return null;
}
return point;
}
public final void setPoint(Collection point) {
this.point = PositionCopier.copy(point);
}
@Override
public final Builder point(Collection point) {
this.point = PositionCopier.copy(point);
return this;
}
@Override
@SafeVarargs
public final Builder point(Double... point) {
point(Arrays.asList(point));
return this;
}
@Override
public PlaceGeometry build() {
return new PlaceGeometry(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}