Package com.helger.commons.dimension

Class SizeLong

java.lang.Object

com.helger.commons.dimension.SizeLong

All Implemented Interfaces:

IHasDimensionLong, IHasHeightLong, IHasWidthLong

@Immutable
public class SizeLong
extends Object
implements IHasDimensionLong

This class represents an object having width and height.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
SizeLong(long nWidth, long nHeight)
SizeLong(IHasDimensionInt aObj)
SizeLong(IHasDimensionLong aObj)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
SizeLong	getAdded(IHasDimensionLong aToAdd)
SizeLong	getBestMatchingSize(long nMaxWidth, long nMaxHeight)	Return the scaled width and height relative to a maximum size.
long	getHeight()
SizeLong	getScaledToHeight(long nNewHeight)
SizeLong	getScaledToWidth(long nNewWidth)
SizeLong	getSubtracted(IHasDimensionLong aToSubtract)
long	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.IHasDimensionLong

isLandscape, isPortrait, isQuadratic

Constructor Details

SizeLong

public SizeLong(@Nonnull
 IHasDimensionInt aObj)

SizeLong

public SizeLong(@Nonnull
 IHasDimensionLong aObj)

SizeLong

public SizeLong(@Nonnegative
 long nWidth,
 @Nonnegative
 long nHeight)

Method Details

getWidth

@Nonnegative
public long getWidth()

Specified by:

getWidth in interface IHasWidthLong

Returns:

The width of an object

getHeight

@Nonnegative
public long getHeight()

Specified by:

getHeight in interface IHasHeightLong

Returns:

The height of an object

getBestMatchingSize

@Nonnull
@CheckReturnValue
public SizeLong getBestMatchingSize(@Nonnegative
 long nMaxWidth,
 @Nonnegative
 long 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 SizeLong getScaledToWidth(@Nonnegative
 long nNewWidth)

getScaledToHeight

@Nonnull
@CheckReturnValue
public SizeLong getScaledToHeight(@Nonnegative
 long nNewHeight)

getAdded

@Nonnull
@CheckReturnValue
public SizeLong getAdded(@Nonnull
 IHasDimensionLong aToAdd)

getSubtracted

@Nonnull
@CheckReturnValue
public SizeLong getSubtracted(@Nonnull
 IHasDimensionLong 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