/* * Copyright 2010-2023 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 com.amazonaws.services.geo.model; import java.io.Serializable; /** *

* Contains the position update details for a device. *

*/ public class DevicePositionUpdate implements Serializable { /** *

* The accuracy of the device position. *

*/ private PositionalAccuracy accuracy; /** *

* The device associated to the position update. *

*

* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\p{L}\p{N}]+$
*/ private String deviceId; /** *

* The latest device position defined in WGS 84 format: [X or longitude, Y or latitude]. *

*/ private java.util.List position; /** *

* Associates one of more properties with the position update. A property is * a key-value pair stored with the position update and added to any * geofence event the update may trigger. *

*

* Format: "key" : "value" *

*/ private java.util.Map positionProperties; /** *

* The timestamp at which the device's position was determined. Uses ISO * 8601 format: YYYY-MM-DDThh:mm:ss.sssZ *

*/ private java.util.Date sampleTime; /** *

* The accuracy of the device position. *

* * @return

* The accuracy of the device position. *

*/ public PositionalAccuracy getAccuracy() { return accuracy; } /** *

* The accuracy of the device position. *

* * @param accuracy

* The accuracy of the device position. *

*/ public void setAccuracy(PositionalAccuracy accuracy) { this.accuracy = accuracy; } /** *

* The accuracy of the device position. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param accuracy

* The accuracy of the device position. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DevicePositionUpdate withAccuracy(PositionalAccuracy accuracy) { this.accuracy = accuracy; return this; } /** *

* The device associated to the position update. *

*

* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\p{L}\p{N}]+$
* * @return

* The device associated to the position update. *

*/ public String getDeviceId() { return deviceId; } /** *

* The device associated to the position update. *

*

* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\p{L}\p{N}]+$
* * @param deviceId

* The device associated to the position update. *

*/ public void setDeviceId(String deviceId) { this.deviceId = deviceId; } /** *

* The device associated to the position update. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\p{L}\p{N}]+$
* * @param deviceId

* The device associated to the position update. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DevicePositionUpdate withDeviceId(String deviceId) { this.deviceId = deviceId; return this; } /** *

* The latest device position defined in WGS 84 format: [X or longitude, Y or latitude]. *

* * @return

* The latest device position defined in WGS 84 format: [X or longitude, Y or latitude]. *

*/ public java.util.List getPosition() { return position; } /** *

* The latest device position defined in WGS 84 format: [X or longitude, Y or latitude]. *

* * @param position

* The latest device position defined in WGS 84 format: * [X or longitude, Y or latitude]. *

*/ public void setPosition(java.util.Collection position) { if (position == null) { this.position = null; return; } this.position = new java.util.ArrayList(position); } /** *

* The latest device position defined in WGS 84 format: [X or longitude, Y or latitude]. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param position

* The latest device position defined in WGS 84 format: * [X or longitude, Y or latitude]. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DevicePositionUpdate withPosition(Double... position) { if (getPosition() == null) { this.position = new java.util.ArrayList(position.length); } for (Double value : position) { this.position.add(value); } return this; } /** *

* The latest device position defined in WGS 84 format: [X or longitude, Y or latitude]. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param position

* The latest device position defined in WGS 84 format: * [X or longitude, Y or latitude]. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DevicePositionUpdate withPosition(java.util.Collection position) { setPosition(position); return this; } /** *

* Associates one of more properties with the position update. A property is * a key-value pair stored with the position update and added to any * geofence event the update may trigger. *

*

* Format: "key" : "value" *

* * @return

* Associates one of more properties with the position update. A * property is a key-value pair stored with the position update and * added to any geofence event the update may trigger. *

*

* Format: "key" : "value" *

*/ public java.util.Map getPositionProperties() { return positionProperties; } /** *

* Associates one of more properties with the position update. A property is * a key-value pair stored with the position update and added to any * geofence event the update may trigger. *

*

* Format: "key" : "value" *

* * @param positionProperties

* Associates one of more properties with the position update. A * property is a key-value pair stored with the position update * and added to any geofence event the update may trigger. *

*

* Format: "key" : "value" *

*/ public void setPositionProperties(java.util.Map positionProperties) { this.positionProperties = positionProperties; } /** *

* Associates one of more properties with the position update. A property is * a key-value pair stored with the position update and added to any * geofence event the update may trigger. *

*

* Format: "key" : "value" *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param positionProperties

* Associates one of more properties with the position update. A * property is a key-value pair stored with the position update * and added to any geofence event the update may trigger. *

*

* Format: "key" : "value" *

* @return A reference to this updated object so that method calls can be * chained together. */ public DevicePositionUpdate withPositionProperties( java.util.Map positionProperties) { this.positionProperties = positionProperties; return this; } /** *

* Associates one of more properties with the position update. A property is * a key-value pair stored with the position update and added to any * geofence event the update may trigger. *

*

* Format: "key" : "value" *

*

* The method adds a new key-value pair into PositionProperties parameter, * and returns a reference to this object so that method calls can be * chained together. * * @param key The key of the entry to be added into PositionProperties. * @param value The corresponding value of the entry to be added into * PositionProperties. * @return A reference to this updated object so that method calls can be * chained together. */ public DevicePositionUpdate addPositionPropertiesEntry(String key, String value) { if (null == this.positionProperties) { this.positionProperties = new java.util.HashMap(); } if (this.positionProperties.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.positionProperties.put(key, value); return this; } /** * Removes all the entries added into PositionProperties. *

* Returns a reference to this object so that method calls can be chained * together. */ public DevicePositionUpdate clearPositionPropertiesEntries() { this.positionProperties = null; return this; } /** *

* The timestamp at which the device's position was determined. Uses ISO * 8601 format: YYYY-MM-DDThh:mm:ss.sssZ *

* * @return

* The timestamp at which the device's position was determined. Uses * * ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ *

*/ public java.util.Date getSampleTime() { return sampleTime; } /** *

* The timestamp at which the device's position was determined. Uses ISO * 8601 format: YYYY-MM-DDThh:mm:ss.sssZ *

* * @param sampleTime

* The timestamp at which the device's position was determined. * Uses ISO * 8601 format: YYYY-MM-DDThh:mm:ss.sssZ *

*/ public void setSampleTime(java.util.Date sampleTime) { this.sampleTime = sampleTime; } /** *

* The timestamp at which the device's position was determined. Uses ISO * 8601 format: YYYY-MM-DDThh:mm:ss.sssZ *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param sampleTime

* The timestamp at which the device's position was determined. * Uses ISO * 8601 format: YYYY-MM-DDThh:mm:ss.sssZ *

* @return A reference to this updated object so that method calls can be * chained together. */ public DevicePositionUpdate withSampleTime(java.util.Date sampleTime) { this.sampleTime = sampleTime; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getAccuracy() != null) sb.append("Accuracy: " + getAccuracy() + ","); if (getDeviceId() != null) sb.append("DeviceId: " + getDeviceId() + ","); if (getPosition() != null) sb.append("Position: " + getPosition() + ","); if (getPositionProperties() != null) sb.append("PositionProperties: " + getPositionProperties() + ","); if (getSampleTime() != null) sb.append("SampleTime: " + getSampleTime()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getAccuracy() == null) ? 0 : getAccuracy().hashCode()); hashCode = prime * hashCode + ((getDeviceId() == null) ? 0 : getDeviceId().hashCode()); hashCode = prime * hashCode + ((getPosition() == null) ? 0 : getPosition().hashCode()); hashCode = prime * hashCode + ((getPositionProperties() == null) ? 0 : getPositionProperties().hashCode()); hashCode = prime * hashCode + ((getSampleTime() == null) ? 0 : getSampleTime().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DevicePositionUpdate == false) return false; DevicePositionUpdate other = (DevicePositionUpdate) obj; if (other.getAccuracy() == null ^ this.getAccuracy() == null) return false; if (other.getAccuracy() != null && other.getAccuracy().equals(this.getAccuracy()) == false) return false; if (other.getDeviceId() == null ^ this.getDeviceId() == null) return false; if (other.getDeviceId() != null && other.getDeviceId().equals(this.getDeviceId()) == false) return false; if (other.getPosition() == null ^ this.getPosition() == null) return false; if (other.getPosition() != null && other.getPosition().equals(this.getPosition()) == false) return false; if (other.getPositionProperties() == null ^ this.getPositionProperties() == null) return false; if (other.getPositionProperties() != null && other.getPositionProperties().equals(this.getPositionProperties()) == false) return false; if (other.getSampleTime() == null ^ this.getSampleTime() == null) return false; if (other.getSampleTime() != null && other.getSampleTime().equals(this.getSampleTime()) == false) return false; return true; } }