Top Description Fields Constructors Methods
org.postgresql.geometric

public Class PGpath

extends PGobject
implements Serializable, Cloneable
Class Inheritance
All Implemented Interfaces
java.lang.Cloneable, java.io.Serializable
Imports
org.postgresql.util.GT, .PGobject, .PGtokenizer, .PSQLException, .PSQLState, org.checkerframework.checker.nullness.qual.Nullable, java.io.Serializable, java.sql.SQLException

This implements a path (a multiple segmented line, which may be closed).

Field Summary

Modifier and TypeField and Description
public boolean
open

True if the path is open, false if closed.

public @Nullable PGpoint[]
points

The points defining this path.

Inherited from org.postgresql.util.PGobject:
typevalue

Constructor Summary

AccessConstructor and Description
public
PGpath(@Nullable PGpoint[]
the PGpoints that define the path
points
,
boolean
True if the path is open, false if closed
open
)

public
PGpath()

Required by the driver.

public
PGpath(String
definition of the path in PostgreSQL's syntax.
s
)

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 void
public boolean

Returns:

true if the two paths 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 value of this object
getValue
()

Overrides org.postgresql.util.PGobject.getValue.

This returns the path in the syntax expected by org.postgresql.

public int
public boolean
public boolean
public void
public void
setValue(@Nullable String
Definition of the path in PostgreSQL's syntax
s
)

Inherited from org.postgresql.util.PGobject:
equalsequalsgetTypeisNullsetTypesetValuetoString

Field Detail

openback to summary
public boolean open

True if the path is open, false if closed.

pointsback to summary
public @Nullable PGpoint[] points

The points defining this path.

Constructor Detail

PGpathback to summary
public PGpath(@Nullable PGpoint[] points, boolean open)
Parameters
points:@Nullable PGpoint[]

the PGpoints that define the path

open:boolean

True if the path is open, false if closed

PGpathback to summary
public PGpath()

Required by the driver.

PGpathback to summary
public PGpath(String s) throws SQLException
Parameters
s:String

definition of the path in PostgreSQL's syntax.

Annotations
@SuppressWarnings:method.invocation
Exceptions
SQLException:
on conversion failure

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.

closePathback to summary
public void closePath()
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 paths are identical

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

Overrides org.postgresql.util.PGobject.getValue.

This returns the path in the syntax expected by org.postgresql.

Returns:@Nullable String

the value of this object

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
isClosedback to summary
public boolean isClosed()
isOpenback to summary
public boolean isOpen()
openPathback to summary
public void openPath()
setValueback to summary
public void setValue(@Nullable String s) throws SQLException
Parameters
s:@Nullable String

Definition of the path in PostgreSQL's syntax

Annotations
@Override
Exceptions
SQLException:
on conversion failure