com.amazonaws.services.rekognition.model.Landmark Maven / Gradle / Ivy
/*
* 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.rekognition.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Indicates the location of the landmark on the face.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Landmark implements Serializable, Cloneable, StructuredPojo {
/**
*
* Type of landmark.
*
*/
private String type;
/**
*
* The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is measured
* from the left-side of the image. For example, if the image is 700 pixels wide and the x-coordinate of the
* landmark is at 350 pixels, this value is 0.5.
*
*/
private Float x;
/**
*
* The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is measured
* from the top of the image. For example, if the image height is 200 pixels and the y-coordinate of the landmark is
* at 50 pixels, this value is 0.25.
*
*/
private Float y;
/**
*
* Type of landmark.
*
*
* @param type
* Type of landmark.
* @see LandmarkType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* Type of landmark.
*
*
* @return Type of landmark.
* @see LandmarkType
*/
public String getType() {
return this.type;
}
/**
*
* Type of landmark.
*
*
* @param type
* Type of landmark.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LandmarkType
*/
public Landmark withType(String type) {
setType(type);
return this;
}
/**
*
* Type of landmark.
*
*
* @param type
* Type of landmark.
* @see LandmarkType
*/
public void setType(LandmarkType type) {
withType(type);
}
/**
*
* Type of landmark.
*
*
* @param type
* Type of landmark.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LandmarkType
*/
public Landmark withType(LandmarkType type) {
this.type = type.toString();
return this;
}
/**
*
* The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is measured
* from the left-side of the image. For example, if the image is 700 pixels wide and the x-coordinate of the
* landmark is at 350 pixels, this value is 0.5.
*
*
* @param x
* The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is
* measured from the left-side of the image. For example, if the image is 700 pixels wide and the
* x-coordinate of the landmark is at 350 pixels, this value is 0.5.
*/
public void setX(Float x) {
this.x = x;
}
/**
*
* The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is measured
* from the left-side of the image. For example, if the image is 700 pixels wide and the x-coordinate of the
* landmark is at 350 pixels, this value is 0.5.
*
*
* @return The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is
* measured from the left-side of the image. For example, if the image is 700 pixels wide and the
* x-coordinate of the landmark is at 350 pixels, this value is 0.5.
*/
public Float getX() {
return this.x;
}
/**
*
* The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is measured
* from the left-side of the image. For example, if the image is 700 pixels wide and the x-coordinate of the
* landmark is at 350 pixels, this value is 0.5.
*
*
* @param x
* The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is
* measured from the left-side of the image. For example, if the image is 700 pixels wide and the
* x-coordinate of the landmark is at 350 pixels, this value is 0.5.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Landmark withX(Float x) {
setX(x);
return this;
}
/**
*
* The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is measured
* from the top of the image. For example, if the image height is 200 pixels and the y-coordinate of the landmark is
* at 50 pixels, this value is 0.25.
*
*
* @param y
* The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is
* measured from the top of the image. For example, if the image height is 200 pixels and the y-coordinate of
* the landmark is at 50 pixels, this value is 0.25.
*/
public void setY(Float y) {
this.y = y;
}
/**
*
* The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is measured
* from the top of the image. For example, if the image height is 200 pixels and the y-coordinate of the landmark is
* at 50 pixels, this value is 0.25.
*
*
* @return The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is
* measured from the top of the image. For example, if the image height is 200 pixels and the y-coordinate
* of the landmark is at 50 pixels, this value is 0.25.
*/
public Float getY() {
return this.y;
}
/**
*
* The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is measured
* from the top of the image. For example, if the image height is 200 pixels and the y-coordinate of the landmark is
* at 50 pixels, this value is 0.25.
*
*
* @param y
* The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is
* measured from the top of the image. For example, if the image height is 200 pixels and the y-coordinate of
* the landmark is at 50 pixels, this value is 0.25.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Landmark withY(Float y) {
setY(y);
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 (getType() != null)
sb.append("Type: ").append(getType()).append(",");
if (getX() != null)
sb.append("X: ").append(getX()).append(",");
if (getY() != null)
sb.append("Y: ").append(getY());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Landmark == false)
return false;
Landmark other = (Landmark) obj;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
if (other.getX() == null ^ this.getX() == null)
return false;
if (other.getX() != null && other.getX().equals(this.getX()) == false)
return false;
if (other.getY() == null ^ this.getY() == null)
return false;
if (other.getY() != null && other.getY().equals(this.getY()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
hashCode = prime * hashCode + ((getX() == null) ? 0 : getX().hashCode());
hashCode = prime * hashCode + ((getY() == null) ? 0 : getY().hashCode());
return hashCode;
}
@Override
public Landmark clone() {
try {
return (Landmark) 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.rekognition.model.transform.LandmarkMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}