com.amazonaws.services.location.model.TruckWeight Maven / Gradle / Ivy
Show all versions of aws-java-sdk-location Show documentation
/*
* Copyright 2019-2024 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.location.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Contains details about the truck's weight specifications. Used to avoid roads that can't support or allow the total
* weight for requests that specify TravelMode
as Truck
.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class TruckWeight implements Serializable, Cloneable, StructuredPojo {
/**
*
* The total weight of the truck.
*
*
* -
*
* For example, 3500
.
*
*
*
*/
private Double total;
/**
*
* The unit of measurement to use for the truck weight.
*
*
* Default Value: Kilograms
*
*/
private String unit;
/**
*
* The total weight of the truck.
*
*
* -
*
* For example, 3500
.
*
*
*
*
* @param total
* The total weight of the truck.
*
* -
*
* For example, 3500
.
*
*
*/
public void setTotal(Double total) {
this.total = total;
}
/**
*
* The total weight of the truck.
*
*
* -
*
* For example, 3500
.
*
*
*
*
* @return The total weight of the truck.
*
* -
*
* For example, 3500
.
*
*
*/
public Double getTotal() {
return this.total;
}
/**
*
* The total weight of the truck.
*
*
* -
*
* For example, 3500
.
*
*
*
*
* @param total
* The total weight of the truck.
*
* -
*
* For example, 3500
.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TruckWeight withTotal(Double total) {
setTotal(total);
return this;
}
/**
*
* The unit of measurement to use for the truck weight.
*
*
* Default Value: Kilograms
*
*
* @param unit
* The unit of measurement to use for the truck weight.
*
* Default Value: Kilograms
* @see VehicleWeightUnit
*/
public void setUnit(String unit) {
this.unit = unit;
}
/**
*
* The unit of measurement to use for the truck weight.
*
*
* Default Value: Kilograms
*
*
* @return The unit of measurement to use for the truck weight.
*
* Default Value: Kilograms
* @see VehicleWeightUnit
*/
public String getUnit() {
return this.unit;
}
/**
*
* The unit of measurement to use for the truck weight.
*
*
* Default Value: Kilograms
*
*
* @param unit
* The unit of measurement to use for the truck weight.
*
* Default Value: Kilograms
* @return Returns a reference to this object so that method calls can be chained together.
* @see VehicleWeightUnit
*/
public TruckWeight withUnit(String unit) {
setUnit(unit);
return this;
}
/**
*
* The unit of measurement to use for the truck weight.
*
*
* Default Value: Kilograms
*
*
* @param unit
* The unit of measurement to use for the truck weight.
*
* Default Value: Kilograms
* @return Returns a reference to this object so that method calls can be chained together.
* @see VehicleWeightUnit
*/
public TruckWeight withUnit(VehicleWeightUnit unit) {
this.unit = unit.toString();
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getTotal() != null)
sb.append("Total: ").append(getTotal()).append(",");
if (getUnit() != null)
sb.append("Unit: ").append(getUnit());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof TruckWeight == false)
return false;
TruckWeight other = (TruckWeight) obj;
if (other.getTotal() == null ^ this.getTotal() == null)
return false;
if (other.getTotal() != null && other.getTotal().equals(this.getTotal()) == false)
return false;
if (other.getUnit() == null ^ this.getUnit() == null)
return false;
if (other.getUnit() != null && other.getUnit().equals(this.getUnit()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTotal() == null) ? 0 : getTotal().hashCode());
hashCode = prime * hashCode + ((getUnit() == null) ? 0 : getUnit().hashCode());
return hashCode;
}
@Override
public TruckWeight clone() {
try {
return (TruckWeight) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.location.model.transform.TruckWeightMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}