Top Description Fields Constructors Methods
org.postgresql.replication

public final Class LogSequenceNumber

extends Object
implements Comparable<LogSequenceNumber>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable
Imports
org.checkerframework.checker.nullness.qual.Nullable, java.nio.ByteBuffer

LSN (Log Sequence Number) data which is a pointer to a location in the XLOG.

Field Summary

Modifier and TypeField and Description
public static final LogSequenceNumber
INVALID_LSN

Zero is used indicate an invalid pointer.

private final long

Constructor Summary

AccessConstructor and Description
private
LogSequenceNumber(long value)

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

Long represent position in the write-ahead log stream
asLong
()

public String

Returns:

String represent position in the write-ahead log stream as two hexadecimal numbers of up to 8 digits each, separated by a slash. For example 16/3002D50, 0/15D68C50
asString
()

public int
compareTo(LogSequenceNumber
the object to be compared.
o
)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.

public boolean
equals(@Nullable Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

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

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public static LogSequenceNumber

Returns:

not null LSN instance
valueOf
(long
numeric represent position in the write-ahead log stream
value
)

public static LogSequenceNumber

Returns:

not null LSN instance where if specified string represent have not valid form LogSequenceNumber#INVALID_LSN
valueOf
(String
not null string as two hexadecimal numbers of up to 8 digits each, separated by a slash. For example 16/3002D50, 0/15D68C50
strValue
)

Create LSN instance by string represent LSN.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

INVALID_LSNback to summary
public static final LogSequenceNumber INVALID_LSN

Zero is used indicate an invalid pointer. Bootstrap skips the first possible WAL segment, initializing the first WAL page at XLOG_SEG_SIZE, so no XLOG record can begin at zero.

valueback to summary
private final long value

Constructor Detail

LogSequenceNumberback to summary
private LogSequenceNumber(long value)

Method Detail

asLongback to summary
public long asLong()
Returns:long

Long represent position in the write-ahead log stream

asStringback to summary
public String asString()
Returns:String

String represent position in the write-ahead log stream as two hexadecimal numbers of up to 8 digits each, separated by a slash. For example 16/3002D50, 0/15D68C50

compareToback to summary
public int compareTo(LogSequenceNumber o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
o:LogSequenceNumber

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations
@Override
equalsback to summary
public boolean equals(@Nullable Object o)

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
o:@Nullable Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
valueOfback to summary
public static LogSequenceNumber valueOf(long value)
Parameters
value:long

numeric represent position in the write-ahead log stream

Returns:LogSequenceNumber

not null LSN instance

valueOfback to summary
public static LogSequenceNumber valueOf(String strValue)

Create LSN instance by string represent LSN.

Parameters
strValue:String

not null string as two hexadecimal numbers of up to 8 digits each, separated by a slash. For example 16/3002D50, 0/15D68C50

Returns:LogSequenceNumber

not null LSN instance where if specified string represent have not valid form LogSequenceNumber#INVALID_LSN