Module com.io7m.jregions.core

Package com.io7m.jregions.core.unparameterized.areas

Interface AreaLType

All Superinterfaces:

AreaSizeValuesLType, AreaValuesLType

All Known Implementing Classes:

AreaL

@Immutable
public interface AreaLType
extends AreaValuesLType

An area with long coordinates.

The coordinates of the area are given in half-closed form. That is, minimumX() refers to the minimum inclusive value on the X axis, and maximumX() refers to the maximum exclusive value on the X axis. Likewise for the Y axis.

Method Summary

Modifier and Type	Method	Description
default void	checkPreconditions()	Check the preconditions for the parameters.
long	maximumX()
long	maximumY()
long	minimumX()
long	minimumY()

Methods inherited from interface com.io7m.jregions.core.unparameterized.sizes.AreaSizeValuesLType

height, width

Methods inherited from interface com.io7m.jregions.core.unparameterized.areas.AreaValuesLType

sizeX, sizeY

Method Detail

minimumX

@Parameter(order=0)
long minimumX()

Specified by:

minimumX in interface AreaValuesLType

Returns:

The value on the X axis of the minimum edge of the box (inclusive)

maximumX

@Parameter(order=1)
long maximumX()

Specified by:

maximumX in interface AreaValuesLType

Returns:

The value on the X axis of the maximum edge of the box (exclusive)

minimumY

@Parameter(order=2)
long minimumY()

Specified by:

minimumY in interface AreaValuesLType

Returns:

The value on the Y axis of the minimum edge of the box (inclusive)

maximumY

@Parameter(order=3)
long maximumY()

Specified by:

maximumY in interface AreaValuesLType

Returns:

The value on the Y axis of the maximum edge of the box (exclusive)

checkPreconditions

@Check
default void checkPreconditions()

Check the preconditions for the parameters.