joynr.vehicle.GeoPosition Maven / Gradle / Ivy

Go to download
		/*
		 *
		 * Copyright (C) 2011 - 2017 BMW Car IT GmbH
		 *
		 * Licensed under the Apache License, Version 2.0 (the "License");
		 * you may not use this file except in compliance with the License.
		 * You may obtain a copy of the License at
		 *
		 *      http://www.apache.org/licenses/LICENSE-2.0
		 *
		 * Unless required by applicable law or agreed to in writing, software
		 * distributed under the License 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.
		 */
		
		// #####################################################
		//#######################################################
		//###                                                 ###
		//##    WARNING: This file is generated. DO NOT EDIT   ##
		//##             All changes will be lost!             ##
		//###                                                 ###
		//#######################################################
		// #####################################################

package joynr.vehicle;
import java.io.Serializable;

import io.joynr.subtypes.JoynrType;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonIgnore;

// NOTE: serialVersionUID is not defined since we don't support Franca versions right now.
//       The compiler will generate a serialVersionUID based on the class and its members
//       (cf. http://docs.oracle.com/javase/6/docs/platform/serialization/spec/class.html#4100),
//       which is probably more restrictive than what we want.

/**
 * Record describing a geographic location by coordinates
 */
@SuppressWarnings("serial")
public class GeoPosition implements Serializable, JoynrType {
	public static final int MAJOR_VERSION = 0;
	public static final int MINOR_VERSION = 0;
	@JsonProperty("latitude")
	private Double latitude;
	@JsonProperty("longitude")
	private Double longitude;

	/**
	 * Default Constructor
	 */
	public GeoPosition() {
		this.latitude = 0d;
		this.longitude = 0d;
	}

	/**
	 * Copy constructor
	 *
	 * @param geoPositionObj reference to the object to be copied
	 */
	public GeoPosition(GeoPosition geoPositionObj) {
		this.latitude = geoPositionObj.latitude;
		this.longitude = geoPositionObj.longitude;
	}

	/**
	 * Parameterized constructor
	 *
	 * @param latitude The latitude in decimal degrees
	 * @param longitude The longitude in decimal degrees
	 */
	public GeoPosition(
		Double latitude,
		Double longitude
		) {
		this.latitude = latitude;
		this.longitude = longitude;
	}

	/**
	 * Gets Latitude
	 *
	 * @return The latitude in decimal degrees
	 */
	@JsonIgnore
	public Double getLatitude() {
		return this.latitude;
	}

	/**
	 * Sets Latitude
	 *
	 * @param latitude The latitude in decimal degrees
	 */
	@JsonIgnore
	public void setLatitude(Double latitude) {
		if (latitude == null) {
			throw new IllegalArgumentException("setting latitude to null is not allowed");
		}
		this.latitude = latitude;
	}

	/**
	 * Gets Longitude
	 *
	 * @return The longitude in decimal degrees
	 */
	@JsonIgnore
	public Double getLongitude() {
		return this.longitude;
	}

	/**
	 * Sets Longitude
	 *
	 * @param longitude The longitude in decimal degrees
	 */
	@JsonIgnore
	public void setLongitude(Double longitude) {
		if (longitude == null) {
			throw new IllegalArgumentException("setting longitude to null is not allowed");
		}
		this.longitude = longitude;
	}


	/**
	 * Stringifies the class
	 *
	 * @return stringified class content
	 */
	@Override
	public String toString() {
		return "GeoPosition ["
		+ "latitude=" + this.latitude + ", "
		+ "longitude=" + this.longitude
		+ "]";
	}

	/**
	 * Check for equality
	 *
	 * @param obj Reference to the object to compare to
	 * @return true, if objects are equal, false otherwise
	 */
	@Override
	public boolean equals(Object obj) {
		if (this == obj)
			return true;
		if (obj == null)
			return false;
		if (getClass() != obj.getClass())
			return false;
		GeoPosition other = (GeoPosition) obj;
		if (this.latitude == null) {
			if (other.latitude != null) {
				return false;
			}
		} else if (!this.latitude.equals(other.latitude)){
			return false;
		}
		if (this.longitude == null) {
			if (other.longitude != null) {
				return false;
			}
		} else if (!this.longitude.equals(other.longitude)){
			return false;
		}
		return true;
	}

	/**
	 * Calculate code for hashing based on member contents
	 *
	 * @return The calculated hash code
	 */
	@Override
	public int hashCode() {
		int result = 1;
		final int prime = 31;
		result = prime * result + ((this.latitude == null) ? 0 : this.latitude.hashCode());
		result = prime * result + ((this.longitude == null) ? 0 : this.longitude.hashCode());
		return result;
	}
}