net.yadaframework.raw.YadaIntDimension Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of yadaweb Show documentation
Show all versions of yadaweb Show documentation
Some useful tasks for the Yada Framework
package net.yadaframework.raw;
import jakarta.persistence.Embeddable;
/**
* Like java.awt.Dimension but with int values.
*
*/
@Embeddable
public class YadaIntDimension implements java.io.Serializable {
private static final long serialVersionUID = 526069244927838614L;
/**
* UNSET is a special value to be used in @Entity instances instead of null that would generate a constraint violation
*/
public final static YadaIntDimension UNSET = new YadaIntDimension(-1, -1);
/**
* The width dimension; negative values can be used.
*/
// Using Integer would make comparison more difficult
public int width = 0;
/**
* The height dimension; negative values can be used.
*/
// Using Integer would make comparison more difficult
public int height = 0;
/**
* Creates an instance of YadaIntDimension with a width
* of zero and a height of zero.
*/
public YadaIntDimension() {
this(0, 0);
}
/**
* Creates an instance of YadaIntDimension whose width
* and height are the same as for the specified dimension.
*
* @param d the specified dimension for the
* width and
* height values
*/
public YadaIntDimension(YadaIntDimension d) {
this(d.width, d.height);
}
/**
* Constructs a YadaIntDimension and initializes
* it to the specified width and specified height.
*
* @param width the width, null becomes 0
* @param height the height, null becomes 0
*/
public YadaIntDimension(Integer width, Integer height) {
this.width = width==null?0:width;
this.height = height==null?0:height;
}
/**
* Returns the biggest of width and height
* @return
*/
public int getMax() {
return Integer.max(width, height);
}
/**
* Returns the dimension with the width and height that cover all given dimensions.
* @param dimensions can be null or UNSET
* @return a dimension with the maximum width and height from the input arguments, or null when the input is all null or UNSET
*/
public static YadaIntDimension biggestCover(YadaIntDimension...dimensions) {
if (dimensions==null) {
return null;
}
int maxWidth = 0;
int maxHeight = 0;
for (YadaIntDimension dimension : dimensions) {
if (dimension!=null && !dimension.isUnset()) {
if (dimension.getWidth()>maxWidth) {
maxWidth = dimension.getWidth();
}
if (dimension.getHeight()>maxHeight) {
maxHeight = dimension.getHeight();
}
}
}
return new YadaIntDimension(maxWidth, maxHeight);
}
/**
* Returns the dimension with the width or height that has the biggest value, or the first one if there are many that qualify.
* @param dimensions can be null
* @return
*/
public static YadaIntDimension biggest(YadaIntDimension...dimensions) {
if (dimensions==null) {
return null;
}
YadaIntDimension biggest = null;
int bigWidthHeight = 0;
for (YadaIntDimension dimension : dimensions) {
if (dimension!=null && !dimension.isUnset() && dimension.isAnyBiggerThan(biggest)) {
if (dimension.getWidth()>bigWidthHeight || dimension.getHeight()>bigWidthHeight) {
biggest = dimension;
bigWidthHeight = dimension.getMax();
}
}
}
return biggest;
}
/**
* Returns the smallest dimension, or the first one if there are many of the same size
* @param dimensions can be null
* @return
*/
public static YadaIntDimension smallest(YadaIntDimension...dimensions) {
if (dimensions==null) {
return null;
}
YadaIntDimension smallest = null;
for (YadaIntDimension dimension : dimensions) {
if (!dimension.isUnset() && dimension.isSmallerThan(smallest)) {
smallest = dimension;
}
}
return smallest;
}
public boolean isUnset() {
return this.equals(UNSET);
}
/**
* Returns true if both dimensions are not smaller than the argument, nor both equal.
* @param yadaIntDimension can be null or unset and the result would be true
* @return
*/
public boolean isBiggerThan(YadaIntDimension yadaIntDimension) {
if (yadaIntDimension==null || yadaIntDimension.isUnset()) {
return true;
}
return !this.isEqualTo(yadaIntDimension) &&
this.width >= yadaIntDimension.width && this.height >= yadaIntDimension.height;
}
/**
* Returns true if both dimensions are not bigger than the argument, nor both equal.
* @param yadaIntDimension can be null or unset and the result would be true
* @return
*/
public boolean isSmallerThan(YadaIntDimension yadaIntDimension) {
if (yadaIntDimension==null || yadaIntDimension.isUnset()) {
return true;
}
return !this.isEqualTo(yadaIntDimension) &&
this.width <= yadaIntDimension.width && this.height <= yadaIntDimension.height;
}
/**
* Returns true if at least one dimension is bigger.
* @param yadaIntDimension can be null and the result would be true
* @return
*/
public boolean isAnyBiggerThan(YadaIntDimension yadaIntDimension) {
if (yadaIntDimension==null || yadaIntDimension.isUnset()) {
return true;
}
return this.width > yadaIntDimension.width || this.height > yadaIntDimension.height;
}
/**
* Returns true if at least one dimension is smaller.
* @param yadaIntDimension can be null and the result would be true
* @return
*/
public boolean isAnySmallerThan(YadaIntDimension yadaIntDimension) {
if (yadaIntDimension==null || yadaIntDimension.isUnset()) {
return true;
}
return this.width < yadaIntDimension.width || this.height < yadaIntDimension.height;
}
/**
* Returns true if this instance is equal to the argument
* @param yadaIntDimension can be null
* @return
*/
public boolean isEqualTo(YadaIntDimension yadaIntDimension) {
if (yadaIntDimension==null) {
return false;
}
return this.width == yadaIntDimension.width && this.height == yadaIntDimension.height;
}
public int getWidth() {
return width;
}
public int getHeight() {
return height;
}
/**
* Sets the size of this YadaIntDimension object to
* the specified width and height.
*
* @param width the new width for the YadaIntDimension object
* @param height the new height for the YadaIntDimension object
* @since 1.2
*/
public void setSize(int width, int height) {
this.width = width;
this.height = height;
}
/**
* Sets the size of this YadaIntDimension object to the specified size.
*/
public void setSize(YadaIntDimension d) {
setSize(d.width, d.height);
}
/**
* Checks whether two dimension objects have equal values.
*/
public boolean equals(Object obj) {
if (obj instanceof YadaIntDimension) {
YadaIntDimension d = (YadaIntDimension)obj;
return (width == d.width) && (height == d.height);
}
return false;
}
/**
* Returns the hash code for this YadaIntDimension.
*
*/
public int hashCode() {
int sum = width + height;
return sum * (sum + 1)/2 + width;
}
/**
* Returns a string representation in the form WxH
*/
public String toString() {
if (this.equals(UNSET)) {
return "UNSET";
}
return width + "x" + height;
}
}