software.amazon.awssdk.services.location.model.LegGeometry 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;
/**
*
* Contains the geometry details for each path between a pair of positions. Used in plotting a route leg on a map.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class LegGeometry implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField>> LINE_STRING_FIELD = SdkField
.>> builder(MarshallingType.LIST)
.memberName("LineString")
.getter(getter(LegGeometry::lineString))
.setter(setter(Builder::lineString))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LineString").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField.> builder(MarshallingType.LIST)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.DOUBLE)
.traits(LocationTrait.builder()
.location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build())
.build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(LINE_STRING_FIELD));
private static final long serialVersionUID = 1L;
private final List> lineString;
private LegGeometry(BuilderImpl builder) {
this.lineString = builder.lineString;
}
/**
* For responses, this returns true if the service returned a value for the LineString 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 hasLineString() {
return lineString != null && !(lineString instanceof SdkAutoConstructList);
}
/**
*
* An ordered list of positions used to plot a route on a map.
*
*
* The first position is closest to the start position for the leg, and the last position is the closest to the end
* position for the leg.
*
*
* -
*
* For example, [[-123.117, 49.284],[-123.115, 49.285],[-123.115, 49.285]]
*
*
*
*
* 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 #hasLineString} method.
*
*
* @return An ordered list of positions used to plot a route on a map.
*
* The first position is closest to the start position for the leg, and the last position is the closest to
* the end position for the leg.
*
*
* -
*
* For example, [[-123.117, 49.284],[-123.115, 49.285],[-123.115, 49.285]]
*
*
*/
public final List> lineString() {
return lineString;
}
@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(hasLineString() ? lineString() : 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 LegGeometry)) {
return false;
}
LegGeometry other = (LegGeometry) obj;
return hasLineString() == other.hasLineString() && Objects.equals(lineString(), other.lineString());
}
/**
* 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("LegGeometry").add("LineString", lineString() == null ? null : "*** Sensitive Data Redacted ***")
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "LineString":
return Optional.ofNullable(clazz.cast(lineString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((LegGeometry) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* An ordered list of positions used to plot a route on a map.
*
*
* The first position is closest to the start position for the leg, and the last position is the closest to the
* end position for the leg.
*
*
* -
*
* For example, [[-123.117, 49.284],[-123.115, 49.285],[-123.115, 49.285]]
*
*
*
*
* @param lineString
* An ordered list of positions used to plot a route on a map.
*
* The first position is closest to the start position for the leg, and the last position is the closest
* to the end position for the leg.
*
*
* -
*
* For example, [[-123.117, 49.284],[-123.115, 49.285],[-123.115, 49.285]]
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lineString(Collection> lineString);
/**
*
* An ordered list of positions used to plot a route on a map.
*
*
* The first position is closest to the start position for the leg, and the last position is the closest to the
* end position for the leg.
*
*
* -
*
* For example, [[-123.117, 49.284],[-123.115, 49.285],[-123.115, 49.285]]
*
*
*
*
* @param lineString
* An ordered list of positions used to plot a route on a map.
*
* The first position is closest to the start position for the leg, and the last position is the closest
* to the end position for the leg.
*
*
* -
*
* For example, [[-123.117, 49.284],[-123.115, 49.285],[-123.115, 49.285]]
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lineString(Collection... lineString);
}
static final class BuilderImpl implements Builder {
private List> lineString = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(LegGeometry model) {
lineString(model.lineString);
}
public final Collection> getLineString() {
if (lineString instanceof SdkAutoConstructList) {
return null;
}
return lineString;
}
public final void setLineString(Collection> lineString) {
this.lineString = LineStringCopier.copy(lineString);
}
@Override
public final Builder lineString(Collection> lineString) {
this.lineString = LineStringCopier.copy(lineString);
return this;
}
@Override
@SafeVarargs
public final Builder lineString(Collection... lineString) {
lineString(Arrays.asList(lineString));
return this;
}
@Override
public LegGeometry build() {
return new LegGeometry(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}