Top Description Fields Constructors Methods
org.postgresql.geometric

public Class PGbox

extends PGobject
implements PGBinaryObject, Serializable, Cloneable
Class Inheritance
All Implemented Interfaces
java.lang.Cloneable, java.io.Serializable, org.postgresql.util.PGBinaryObject
Static Imports
org.postgresql.util.internal.Nullness.castNonNull
This represents the box datatype within org.postgresql.

Field Summary

Modifier and TypeField and Description
public @Nullable PGpoint[]
point

These are the two points.

Inherited from org.postgresql.util.PGobject:
typevalue

Constructor Summary

AccessConstructor and Description
public
PGbox(double
first x coordinate
x1, double
first y coordinate
y1, double
second x coordinate
x2, double
second y coordinate
y2)

public
PGbox(PGpoint
first point
p1, PGpoint
second point
p2)

public
PGbox(String
Box definition in PostgreSQL syntax
s)

public
PGbox()

Required constructor.

Method Summary

Modifier and TypeMethod and Description
public Object
clone()

Overrides org.postgresql.util.PGobject.clone.

This must be overridden to allow the object to be cloned.

public boolean

Returns:

true if the two boxes are identical
equals(@Nullable Object
Object to compare with
obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public @Nullable String

Returns:

the PGbox in the syntax expected by org.postgresql
getValue()

Overrides org.postgresql.util.PGobject.getValue.

This must be overridden, to return the value of the object, in the form required by org.postgresql.

public int
hashCode()

Overrides org.postgresql.util.PGobject.hashCode.

Compute hash.

public int
lengthInBytes()

Implements org.postgresql.util.PGBinaryObject.lengthInBytes.

This method is called to return the number of bytes needed to store this object in the binary form required by org.postgresql.

public void
setByteValue(byte[]
Definition of this point in PostgreSQL's binary syntax
b, int
the offset in the byte array where object data starts
offset)

Implements org.postgresql.util.PGBinaryObject.setByteValue.

This method is called to set the value of this object.

public void
setValue(@Nullable String
a string representation of the value of the object
value)

This method sets the value of this object.

public void
toBytes(byte[]
the array to store the value, it is guaranteed to be at lest lengthInBytes in size.
bytes, int
the offset in the byte array where object must be stored
offset)

Implements org.postgresql.util.PGBinaryObject.toBytes.

This method is called the to store the value of the object, in the binary form required by org.postgresql.

Inherited from org.postgresql.util.PGobject:
equalsequalsgetTypeisNullsetTypesetValuetoString

Field Detail

pointback to summary
public @Nullable PGpoint[] point

These are the two points.

Constructor Detail

PGboxback to summary
public PGbox(double x1, double y1, double x2, double y2)
Parameters
x1:double

first x coordinate

y1:double

first y coordinate

x2:double

second x coordinate

y2:double

second y coordinate

PGboxback to summary
public PGbox(PGpoint p1, PGpoint p2)
Parameters
p1:PGpoint

first point

p2:PGpoint

second point

PGboxback to summary
public PGbox(String s) throws SQLException
Parameters
s:String

Box definition in PostgreSQL syntax

Annotations
@SuppressWarnings:method.invocation
Exceptions
SQLException:
if definition is invalid
PGboxback to summary
public PGbox()

Required constructor.

Method Detail

cloneback to summary
public Object clone() throws CloneNotSupportedException

Overrides org.postgresql.util.PGobject.clone.

Doc from org.postgresql.util.PGobject.clone.

This must be overridden to allow the object to be cloned.

Returns:Object

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations
@Override
Exceptions
CloneNotSupportedException:

Doc from java.lang.Object.clone.

if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

equalsback to summary
public boolean equals(@Nullable Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:@Nullable Object

Object to compare with

Returns:boolean

true if the two boxes are identical

Annotations
@Override
getValueback to summary
public @Nullable String getValue()

Overrides org.postgresql.util.PGobject.getValue.

Doc from org.postgresql.util.PGobject.getValue.

This must be overridden, to return the value of the object, in the form required by org.postgresql.

Returns:@Nullable String

the PGbox in the syntax expected by org.postgresql

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides org.postgresql.util.PGobject.hashCode.

Doc from org.postgresql.util.PGobject.hashCode.

Compute hash. As equals() use only value. Return the same hash for the same value.

Returns:int

Value hashcode, 0 if value is null java.util.Objects#hashCode(Object)

Annotations
@Override
lengthInBytesback to summary
public int lengthInBytes()

Implements org.postgresql.util.PGBinaryObject.lengthInBytes.

Doc from org.postgresql.util.PGBinaryObject.lengthInBytes.

This method is called to return the number of bytes needed to store this object in the binary form required by org.postgresql.

Returns:int

the number of bytes needed to store this object

Annotations
@Override
setByteValueback to summary
public void setByteValue(byte[] b, int offset)

Implements org.postgresql.util.PGBinaryObject.setByteValue.

Doc from org.postgresql.util.PGBinaryObject.setByteValue.

This method is called to set the value of this object.

Parameters
b:byte[]

Definition of this point in PostgreSQL's binary syntax

offset:int

the offset in the byte array where object data starts

Annotations
@Override
setValueback to summary
public void setValue(@Nullable String value) throws SQLException

This method sets the value of this object. It should be overridden, but still called by subclasses.

Parameters
value:@Nullable String

a string representation of the value of the object

Annotations
@Override
Exceptions
SQLException:
thrown if value is invalid for this type
toBytesback to summary
public void toBytes(byte[] bytes, int offset)

Implements org.postgresql.util.PGBinaryObject.toBytes.

Doc from org.postgresql.util.PGBinaryObject.toBytes.

This method is called the to store the value of the object, in the binary form required by org.postgresql.

Parameters
bytes:byte[]

the array to store the value, it is guaranteed to be at lest lengthInBytes in size.

offset:int

the offset in the byte array where object must be stored

Annotations
@Override