Rect (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.util.Rect

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable
```
public class Rect
extends java.lang.Object
implements java.io.Externalizable
```
Represents an immutable rectangle defined by its bottom-left and top-right coordinates.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Rect.Edge
The Edge class represents an edge of a rectangle defined by its starting and ending coordinates.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Rect.Edge` The Edge class represents an edge of a rectangle defined by its starting and ending coordinates.

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`hashCode` Transient cached hash code value.
`private int`	`x1` Represents a rectangle defined by its bottom-left and top-right coordinates.
`private int`	`x2` Represents a rectangle defined by its bottom-left and top-right coordinates.
`private int`	`y1` Represents a rectangle defined by its bottom-left and top-right coordinates.
`private int`	`y2` Represents a rectangle defined by its bottom-left and top-right coordinates.

Constructor Summary

Constructors
Constructor and Description
`Rect()` The Rect class represents a rectangle defined by its bottom-left and top-right coordinates.
`Rect(int x1, int y1, int x2, int y2)` The Rect class represents a rectangle defined by its bottom-left and top-right coordinates.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(Rect r)` Returns `true` is specified rectangle is completely inside this rectangle.
`boolean`	`empty()` Returns whether the rectangle is empty.
`boolean`	`equals(java.lang.Object o)` Compares this rectangle with the specified object for equality.
`int`	`getX1()` x1 getter.
`int`	`getX2()` x2 getter.
`int`	`getY1()` y1 getter.
`int`	`getY2()` y2 getter.
`int`	`hashCode()` Returns a hash code value for the rectangle object.
`Rect`	`intersection(Rect rect)` Calculate rectangle which is intersection between this and specified rectangle.
`void`	`readExternal(java.io.ObjectInput in)` The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays.
`Rect`	`union(Rect rect)` The union method calculates the rectangle that is the union of the current rectangle and the specified rectangle.
`void`	`writeExternal(java.io.ObjectOutput out)` The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - x1
```
private int x1
```
    Represents a rectangle defined by its bottom-left and top-right coordinates.
  - y1
```
private int y1
```
    Represents a rectangle defined by its bottom-left and top-right coordinates.
  - x2
```
private int x2
```
    Represents a rectangle defined by its bottom-left and top-right coordinates.
  - y2
```
private int y2
```
    Represents a rectangle defined by its bottom-left and top-right coordinates.
  - hashCode
```
private transient int hashCode
```
    Transient cached hash code value.
- Constructor Detail
  - Rect
```
public Rect()
```
    The Rect class represents a rectangle defined by its bottom-left and top-right coordinates.
  - Rect
```
public Rect(int x1,
            int y1,
            int x2,
            int y2)
```
    The Rect class represents a rectangle defined by its bottom-left and top-right coordinates.
    
    Parameters:
    
    x1 - The x-coordinate of the bottom-left corner of the rectangle.
    
    y1 - The y-coordinate of the bottom-left corner of the rectangle.
    
    x2 - The x-coordinate of the top-right corner of the rectangle.
    
    y2 - The y-coordinate of the top-right corner of the rectangle.
- Method Detail
  - getX1
```
public int getX1()
```
    x1 getter.
    
    Returns:
    
    see above.
  - getY1
```
public int getY1()
```
    y1 getter.
    
    Returns:
    
    see above.
  - getX2
```
public int getX2()
```
    x2 getter.
    
    Returns:
    
    see above.
  - getY2
```
public int getY2()
```
    y2 getter.
    
    Returns:
    
    see above.
  - empty
```
public boolean empty()
```
    Returns whether the rectangle is empty.
    
    Returns:
    
    true if the rectangle is empty, false otherwise.
  - intersection
```
public Rect intersection(Rect rect)
```
    Calculate rectangle which is intersection between this and specified rectangle.
    
    Parameters:
    
    rect - Source rectangle.
    
    Returns:
    
    rectangle which is an intersection between this and specified rectangle or null if there is no intersection.
  - union
```
public Rect union(Rect rect)
```
    The union method calculates the rectangle that is the union of the current rectangle and the specified rectangle. The resulting rectangle is the smallest rectangle that contains both rectangles.
    
    Parameters:
    
    rect - The rectangle to calculate the union with.
    
    Returns:
    
    The union of the two rectangles.
  - contains
```
public boolean contains(Rect r)
```
    Returns true is specified rectangle is completely inside this rectangle.
    
    Parameters:
    
    r - Rectangle to check.
    
    Returns:
    
    true if specified rectangle is inside this rectangle.
  - writeExternal
```
public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
```
    The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.
    
    Specified by:
    
    writeExternal in interface java.io.Externalizable
    
    Parameters:
    
    out - the stream to write the object to
    
    Throws:
    
    java.io.IOException - Includes any I/O exceptions that may occur
  - readExternal
```
public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
```
    The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.
    
    Specified by:
    
    readExternal in interface java.io.Externalizable
    
    Parameters:
    
    in - the stream to read data from in order to restore the object
    
    Throws:
    
    java.io.IOException - if I/O errors occur
    
    java.lang.ClassNotFoundException - If the class for an object being restored cannot be found.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Compares this rectangle with the specified object for equality. Returns true if the specified object is also a rectangle and its bottom-left and top-right coordinates are equal to this rectangle's coordinates.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    o - The object to be compared for equality with this rectangle.
    
    Returns:
    
    true if the specified object is equal to this rectangle, false otherwise.
  - hashCode
```
public int hashCode()
```
    Returns a hash code value for the rectangle object. The hash code of a rectangle is computed based on its bottom-left and top-right coordinates.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    the hash code value for the rectangle

Class Rect

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

x1

y1

x2

y2

hashCode

Constructor Detail

Rect

Rect

Method Detail

getX1

getY1

getX2

getY2

empty

intersection

union

contains

writeExternal

readExternal

equals

hashCode