pt.ua.gboard.basic

Class RectangularArea

java.lang.Object

pt.ua.gboard.basic.RectangularArea

public class RectangularArea
extends java.lang.Object

RectangularArea in GBoard.

invariant: topLeftPosition() != null && bottomRightPosition() != null
invariant: topLeftPosition().line() <= bottomRightPosition().line()
invariant: topLeftPosition().column() <= bottomRightPosition().column()

This class follows DbC(tm) methodology. Where possible, contracts are implement with JML and native's Java assert.

Author:

Miguel Oliveira e Silva (mos@ua.pt)

Constructor Summary

Constructors

Constructor and Description
RectangularArea(Position topLeftPosition, Position bottomRightPosition) Constructs a new RectangularArea in GBoard (topLeftPosition x bottomRightPosition).

Method Summary

Modifier and Type	Method and Description
Position	bottomRightPosition() Bottom right position of area.
boolean	isInside(int line, int column) Is position inside area?
boolean	isInside(Position pos) Is position inside area?
Position	topLeftPosition() Top left position of area.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RectangularArea

public RectangularArea(Position topLeftPosition,
                       Position bottomRightPosition)

Constructs a new RectangularArea in GBoard (topLeftPosition x bottomRightPosition).

requires: topLeftPosition != null && bottomRightPosition != null
requires: topLeftPosition.line() <= bottomRightPosition.line()
requires: topLeftPosition.column() <= bottomRightPosition.column()

Parameters:

topLeftPosition - top left position of area

bottomRightPosition - bottom right position of area

Method Detail

topLeftPosition

public Position topLeftPosition()

Top left position of area.

Returns:

Position position

bottomRightPosition

public Position bottomRightPosition()

Bottom right position of area.

Returns:

Position position

isInside

public boolean isInside(Position pos)

Is position inside area?

requires: pos != null

Parameters:

pos - the position to check

Returns:

boolean true if inside

isInside

public boolean isInside(int line,
                        int column)

Is position inside area?

requires: line >= 0 && column >= 0

Parameters:

line - line position

column - column position

Returns:

boolean true if inside

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object