com.helger.commons.dimension

Class SizeInt

java.lang.Object

com.helger.commons.dimension.SizeInt

All Implemented Interfaces:

IHasDimensionInt, IHasHeightInt, IHasWidthInt, Serializable

@Immutable
public class SizeInt
extends Object
implements IHasDimensionInt, Serializable

This class represents an object having width and height.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SizeInt(IHasDimensionInt aObj)
SizeInt(int nWidth, int nHeight)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
SizeInt	getAdded(IHasDimensionInt aToAdd)
SizeInt	getBestMatchingSize(int nMaxWidth, int nMaxHeight) Return the scaled width and height relative to a maximum size.
int	getHeight()
SizeInt	getScaledToHeight(int nNewHeight)
SizeInt	getScaledToWidth(int nNewWidth)
SizeInt	getSubtracted(IHasDimensionInt aToSubtract)
int	getWidth()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.commons.dimension.IHasDimensionInt

isLandscape, isPortrait, isQuadratic

Constructor Detail

SizeInt

public SizeInt(@Nonnull
               IHasDimensionInt aObj)

SizeInt

public SizeInt(@Nonnegative
               int nWidth,
               @Nonnegative
               int nHeight)

Method Detail

getWidth

@Nonnegative
public int getWidth()

Specified by:

getWidth in interface IHasWidthInt

Returns:

The width of an object

getHeight

@Nonnegative
public int getHeight()

Specified by:

getHeight in interface IHasHeightInt

Returns:

The height of an object

getBestMatchingSize

@Nonnull
 @CheckReturnValue
public SizeInt getBestMatchingSize(@Nonnegative
                                                                 int nMaxWidth,
                                                                 @Nonnegative
                                                                 int nMaxHeight)

Return the scaled width and height relative to a maximum size.

Parameters:

nMaxWidth - Maximum width. Must be > 0.

nMaxHeight - Maximum height. Must be > 0.

Returns:

An array with 2 elements, where the first element is the width, and the second is the height.

getScaledToWidth

@Nonnull
 @CheckReturnValue
public SizeInt getScaledToWidth(@Nonnegative
                                                              int nNewWidth)

getScaledToHeight

@Nonnull
 @CheckReturnValue
public SizeInt getScaledToHeight(@Nonnegative
                                                               int nNewHeight)

getAdded

@Nonnull
 @CheckReturnValue
public SizeInt getAdded(@Nonnull
                                                      IHasDimensionInt aToAdd)

getSubtracted

@Nonnull
 @CheckReturnValue
public SizeInt getSubtracted(@Nonnull
                                                           IHasDimensionInt aToSubtract)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object