org.kynosarges.tektosyne.geometry

Class SizeI

java.lang.Object

org.kynosarges.tektosyne.geometry.SizeI

public final class SizeI
extends java.lang.Object

Represents an extension in two-dimensional space, using Integer coordinates. SizeI contains two immutable non-negative Integer dimensions. Use SizeD to represent sizes with Double dimensions.

Field Summary

Fields

Modifier and Type	Field and Description
static SizeI	EMPTY An empty read-only SizeI.
int	height The vertical dimension of the SizeI.
int	width The horizontal dimension of the SizeI.

Constructor Summary

Constructors

Constructor and Description
SizeI() Creates a SizeI with zero extension.
SizeI(int width, int height) Creates a SizeI with the specified extension.

Method Summary

Modifier and Type	Method and Description
SizeI	add(SizeI size) Adds the extension of the specified SizeI to this instance.
boolean	equals(java.lang.Object obj) Compares the specified Object to this SizeI instance.
static SizeI[]	fromInts(int... sizes) Converts the specified Integer array to a SizeI array.
int	hashCode() Returns a hash code for the SizeI.
boolean	isEmpty() Determines whether the SizeI is empty.
SizeI	restrict(int minWidth, int minHeight, int maxWidth, int maxHeight) Restricts the SizeI to the specified extension range.
SizeI	subtract(SizeI size) Subtracts the extension of the specified SizeI from this instance.
static int[]	toInts(SizeI... sizes) Converts the specified SizeI array to an Integer array.
SizeD	toSizeD() Converts the SizeI to a SizeD.
java.lang.String	toString() Returns a String representation of the SizeI.

Methods inherited from class java.lang.Object

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

Field Detail

width

public final int width

The horizontal dimension of the SizeI. Never negative.

height

public final int height

The vertical dimension of the SizeI. Never negative.

EMPTY

public static final SizeI EMPTY

An empty read-only SizeI. Both width and height are set to zero.

Constructor Detail

SizeI

public SizeI()

Creates a SizeI with zero extension. Both width and height are set to zero.

SizeI

public SizeI(int width,
             int height)

Creates a SizeI with the specified extension.

Parameters:

width - the width of the SizeI.

height - the height of the SizeI.

Throws:

java.lang.IllegalArgumentException - if width or height is less than zero

Method Detail

add

public SizeI add(SizeI size)

Adds the extension of the specified SizeI to this instance.

Parameters:

size - the SizeI whose extension to add to this instance

Returns:

a SizeI whose width and height equal the addition of the corresponding dimensions of the specified size to this instance

Throws:

java.lang.ArithmeticException - if the sum in any dimension overflows Integer

java.lang.NullPointerException - if size is null

fromInts

public static SizeI[] fromInts(int... sizes)

Converts the specified Integer array to a SizeI array. The returned array has half as many elements as the specified sizes and retains the same dimension sequence.

Parameters:

sizes - an array containing the width and height components of SizeI instances, stored in alternating index positions

Returns:

the SizeI array created from sizes

Throws:

java.lang.IllegalArgumentException - if sizes has an odd number of elements, or if any width or height is less than zero

java.lang.NullPointerException - if sizes is null

isEmpty

public boolean isEmpty()

Determines whether the SizeI is empty.

Returns:

true if both width and height equal zero, else false

restrict

public SizeI restrict(int minWidth,
                      int minHeight,
                      int maxWidth,
                      int maxHeight)

Restricts the SizeI to the specified extension range.

Parameters:

minWidth - the smallest permissible width

minHeight - the smallest permissible height

maxWidth - the greatest permissible width

maxHeight - the greatest permissible height

Returns:

a SizeI whose width and height equal those of this instance, restricted to the specified extension range

Throws:

java.lang.IllegalArgumentException - if maxWidth or maxHeight is less than zero

subtract

public SizeI subtract(SizeI size)

Subtracts the extension of the specified SizeI from this instance.

Parameters:

size - the SizeI extension to subtract from this instance

Returns:

a SizeI whose width and height equal the subtraction of the corresponding dimensions of the specified size from this instance

Throws:

java.lang.IllegalArgumentException - if the difference in any dimension is less than zero

java.lang.NullPointerException - if size is null

toInts

public static int[] toInts(SizeI... sizes)

Converts the specified SizeI array to an Integer array. The returned array has twice as many elements as the specified sizes and retains the same dimension sequence.

Parameters:

sizes - the SizeI array to convert

Returns:

an array containing the width and height components of all sizes, stored in alternating index positions

Throws:

java.lang.NullPointerException - if sizes or any of its elements is null

toSizeD

public SizeD toSizeD()

Converts the SizeI to a SizeD.

Returns:

a SizeD whose SizeD.width and SizeD.height equal the corresponding dimensions of the SizeI

equals

public boolean equals(java.lang.Object obj)

Compares the specified Object to this SizeI instance.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the Object to compare to this instance

Returns:

true if obj is not null and a SizeI instance whose width and height equal those of this instance, else false

hashCode

public int hashCode()

Returns a hash code for the SizeI.

Overrides:

hashCode in class java.lang.Object

Returns:

an Integer hash code for the SizeI

toString

public java.lang.String toString()

Returns a String representation of the SizeI.

Overrides:

toString in class java.lang.Object

Returns:

a String containing the values of width and height