org.sejda.model

Class RectangularBox

java.lang.Object

org.sejda.model.RectangularBox

@ValidCoordinates
@NotNegativeCoordinates
public final class RectangularBox
extends Object

A rectangular box with rotation capabilities.

Author:

Andrea Vacondio

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object other)
int	getBottom()
int	getLeft()
int	getRight()
int	getTop()
int	hashCode()
static RectangularBox	newInstance(int bottom, int left, int top, int right) static factory method.
static RectangularBox	newInstanceFromPoints(Point bottomLeft, Point topRight) static factory method creating a new instance of the RectangularBox from two points.
void	rotate(Rotation desiredRotation) rotates this RectangularBox using the given rotation.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getBottom

public int getBottom()

getLeft

public int getLeft()

getTop

public int getTop()

getRight

public int getRight()

rotate

public void rotate(Rotation desiredRotation)

rotates this RectangularBox using the given rotation. This method is null safe.

Parameters:

desiredRotation -

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

newInstance

public static RectangularBox newInstance(int bottom,
                         int left,
                         int top,
                         int right)

static factory method.

Parameters:

bottom -

left -

top -

right -

Returns:

the newly created instance.

Throws:

IllegalArgumentException - if one of the arguments is negative, top is lower then bottom or right is lower then left.

newInstanceFromPoints

public static RectangularBox newInstanceFromPoints(Point bottomLeft,
                                   Point topRight)

static factory method creating a new instance of the RectangularBox from two points.

Parameters:

bottomLeft -

topRight -

Returns:

newly created instance.

See Also:

newInstance(int, int, int, int)