java.lang.Object
- org.opends.server.replication.common.CSN

All Implemented Interfaces:

Serializable, Comparable<CSN>
```
public class CSN
extends Object
implements Serializable, Comparable<CSN>
```
Class used to represent Change Sequence Numbers.

See Also:

Inspiration for this class comes from LDAPChangeSequenceNumber, Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`BYTE_ENCODING_LENGTH`	The number of bytes used by the byte string representation of a change number.
`static CSN`	`MAX_CSN_VALUE`	The maximum possible value for a CSN.
`static int`	`STRING_ENCODING_LENGTH`	The number of characters used by the string representation of a change number.

Constructor Summary

Constructors
Constructor Description

CSN(long timeStamp, int seqNum, int serverId)
Create a new CSN.

CSN(String str)
Create a new CSN from a String.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static int`	`compare(CSN csn1, CSN csn2)`	Compares this CSN with the provided CSN for order and returns a negative number if `csn1` is older than `csn2`, zero if they have the same age, or a positive number if `csn1` is newer than `csn2`.
`int`	`compareTo(CSN csn)`	Compares this CSN with the provided CSN for order and returns a negative number if this CSN is older than `csn`, zero if they have the same age, or a positive number if this CSN is newer than `csn`.
`static int`	`diffSeqNum(CSN csn1, CSN csn2)`	Computes the difference in number of changes between 2 CSNs.
`boolean`	`equals(Object obj)`
`int`	`getSeqnum()`	Getter for the sequence number.
`int`	`getServerId()`	Getter for the server ID.
`long`	`getTime()`	Getter for the time.
`long`	`getTimeSec()`	Get the timestamp associated to this `CSN` in seconds.
`int`	`hashCode()`
`boolean`	`isNewerThan(CSN csn)`	Returns `true` if this CSN is newer than the provided CSN.
`boolean`	`isNewerThanOrEqualTo(CSN csn)`	Returns `true` if this CSN is newer than or equal to the provided CSN.
`boolean`	`isOlderThan(CSN csn)`	Returns `true` if this CSN is older than the provided CSN.
`boolean`	`isOlderThanOrEqualTo(CSN csn)`	Returns `true` if this CSN is older than or equal to the provided CSN.
`ByteString`	`toByteString()`	Encodes this CSN as a byte string.
`void`	`toByteString(ByteStringBuilder builder)`	Encodes this CSN into the provided byte string builder.
`String`	`toString()`	Convert the `CSN` to a printable String.
`String`	`toStringUI()`	Convert the `CSN` to a printable String with a user friendly format.
`static CSN`	`valueOf(String s)`	Parses the provided `toString()` representation of a CSN.
`static CSN`	`valueOf(ByteSequence bs)`	Decodes the provided `toByteString()` representation of a change number.

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

- Field Detail
  - BYTE_ENCODING_LENGTH
```
public static final int BYTE_ENCODING_LENGTH
```
    The number of bytes used by the byte string representation of a change number.
    
    See Also:
    
    valueOf(ByteSequence), toByteString(), toByteString(ByteStringBuilder), Constant Field Values
  - STRING_ENCODING_LENGTH
```
public static final int STRING_ENCODING_LENGTH
```
    The number of characters used by the string representation of a change number.
    
    See Also:
    
    valueOf(String), toString(), Constant Field Values
  - MAX_CSN_VALUE
```
public static final CSN MAX_CSN_VALUE
```
    The maximum possible value for a CSN.
- Constructor Detail
  - CSN
```
public CSN(String str)
```
    Create a new CSN from a String.
    
    Parameters:
    
    str - the string from which to create a CSN
    
    Throws:
    
    org.forgerock.i18n.LocalizedIllegalArgumentException - If the provided string is not a valid toString() representation of a CSN
  - CSN
```
public CSN(long timeStamp,
           int seqNum,
           int serverId)
```
    Create a new CSN.
    
    Parameters:
    
    timeStamp - timeStamp for the CSN
    
    seqNum - sequence number
    
    serverId - identity of server
- Method Detail
  - valueOf
```
public static CSN valueOf(String s)
```
    Parses the provided toString() representation of a CSN.
    
    Parameters:
    
    s - The string to be parsed.
    
    Returns:
    
    The parsed CSN.
    
    Throws:
    
    org.forgerock.i18n.LocalizedIllegalArgumentException - If the provided string is not a valid toString() representation of a CSN
    
    See Also:
    
    toString()
  - valueOf
```
public static CSN valueOf(ByteSequence bs)
```
    Decodes the provided toByteString() representation of a change number.
    
    Parameters:
    
    bs - The byte sequence to be parsed.
    
    Returns:
    
    The decoded CSN.
    
    See Also:
    
    toByteString()
  - getTime
```
public long getTime()
```
    Getter for the time.
    
    Returns:
    
    the time
  - getTimeSec
```
public long getTimeSec()
```
    Get the timestamp associated to this CSN in seconds.
    
    Returns:
    
    timestamp associated to this CSN in seconds
  - getSeqnum
```
public int getSeqnum()
```
    Getter for the sequence number.
    
    Returns:
    
    the sequence number
  - getServerId
```
public int getServerId()
```
    Getter for the server ID.
    
    Returns:
    
    the server ID
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toByteString
```
public ByteString toByteString()
```
    Encodes this CSN as a byte string.
    NOTE: this representation must not be modified otherwise interop with earlier protocol versions will be broken.
    
    Returns:
    
    The encoded representation of this CSN.
    
    See Also:
    
    valueOf(ByteSequence)
  - toByteString
```
public void toByteString(ByteStringBuilder builder)
```
    Encodes this CSN into the provided byte string builder.
    NOTE: this representation must not be modified otherwise interop with earlier protocol versions will be broken.
    
    Parameters:
    
    builder - The byte string builder.
    
    See Also:
    
    valueOf(ByteSequence)
  - toString
```
public String toString()
```
    Convert the CSN to a printable String.
    NOTE: this representation must not be modified otherwise interop with earlier protocol versions will be broken.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the string
  - toStringUI
```
public String toStringUI()
```
    Convert the CSN to a printable String with a user friendly format.
    
    Returns:
    
    the string
  - compare
```
public static int compare(CSN csn1,
                          CSN csn2)
```
    Compares this CSN with the provided CSN for order and returns a negative number if csn1 is older than csn2, zero if they have the same age, or a positive number if csn1 is newer than csn2.
    
    Parameters:
    
    csn1 - The first CSN to be compared, which may be null.
    
    csn2 - The second CSN to be compared, which may be null.
    
    Returns:
    
    A negative number if csn1 is older than csn2, zero if they have the same age, or a positive number if csn1 is newer than csn2.
  - diffSeqNum
```
public static int diffSeqNum(CSN csn1,
                             CSN csn2)
```
    Computes the difference in number of changes between 2 CSNs. First one is expected to be newer than second one. If this is not the case, 0 will be returned.
    
    Parameters:
    
    csn1 - the first CSN
    
    csn2 - the second CSN
    
    Returns:
    
    the difference
  - isOlderThan
```
public boolean isOlderThan(CSN csn)
```
    Returns true if this CSN is older than the provided CSN.
    
    Parameters:
    
    csn - The CSN to be compared.
    
    Returns:
    
    true if this CSN is older than the provided CSN.
  - isOlderThanOrEqualTo
```
public boolean isOlderThanOrEqualTo(CSN csn)
```
    Returns true if this CSN is older than or equal to the provided CSN.
    
    Parameters:
    
    csn - The CSN to be compared.
    
    Returns:
    
    true if this CSN is older than or equal to the provided CSN.
  - isNewerThanOrEqualTo
```
public boolean isNewerThanOrEqualTo(CSN csn)
```
    Returns true if this CSN is newer than or equal to the provided CSN.
    
    Parameters:
    
    csn - The CSN to be compared.
    
    Returns:
    
    true if this CSN is newer than or equal to the provided CSN.
  - isNewerThan
```
public boolean isNewerThan(CSN csn)
```
    Returns true if this CSN is newer than the provided CSN.
    
    Parameters:
    
    csn - The CSN to be compared.
    
    Returns:
    
    true if this CSN is newer than the provided CSN.
  - compareTo
```
public int compareTo(CSN csn)
```
    Compares this CSN with the provided CSN for order and returns a negative number if this CSN is older than csn, zero if they have the same age, or a positive number if this CSN is newer than csn.
    
    Specified by:
    
    compareTo in interface Comparable<CSN>
    
    Parameters:
    
    csn - The CSN to be compared.
    
    Returns:
    
    A negative number if this CSN is older than csn, zero if they have the same age, or a positive number if this CSN is newer than csn.

Constructor	Description
`CSN(long timeStamp, int seqNum, int serverId)`	Create a new `CSN`.
`CSN(String str)`	Create a new `CSN` from a String.

Class CSN

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BYTE_ENCODING_LENGTH

STRING_ENCODING_LENGTH

MAX_CSN_VALUE

Constructor Detail

CSN

CSN

Method Detail

valueOf

valueOf

getTime

getTimeSec

getSeqnum

getServerId

equals

hashCode

toByteString

toByteString

toString

toStringUI

compare

diffSeqNum

isOlderThan

isOlderThanOrEqualTo

isNewerThanOrEqualTo

isNewerThan

compareTo