APIdia Launch Partner
Top Description Inners Fields Constructors Methods
io.github.spannm.jackcess.impl

public Class RowIdImpl

extends Object
implements RowId, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, io.github.spannm.jackcess.RowId, java.lang.Comparable
Imports
io.github.spannm.jackcess.RowId, java.io.Serializable

Uniquely identifies a row of data within the access database.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
RowIdImpl.Type

type attributes for RowIds which simplify comparisons

Field Summary

Modifier and TypeField and Description
public static final int
FIRST_PAGE_NUMBER

special page number which will sort before any other valid page number

public static final RowIdImpl
FIRST_ROW_ID

special rowId which will sort before any other valid rowId

public static final int
INVALID_ROW_NUMBER

special row number representing an invalid row number

public static final int
LAST_PAGE_NUMBER

special page number which will sort after any other valid page number

public static final RowIdImpl
LAST_ROW_ID

special rowId which will sort after any other valid rowId

private final int
private final int
private static final long
private final RowIdImpl.Type

Constructor Summary

AccessConstructor and Description
public
RowIdImpl(int pageNumber, int rowNumber)

Creates a new RowId instance.

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(RowId other)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.

public boolean
equals(Object o)

Overrides java.lang.Object.equals.

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

public int
public int
public RowIdImpl.Type
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
isValid()

Returns true if this rowId potentially represents an actual row of data, false otherwise.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

private static RowIdImpl.Type
typeForPageNumber(int pageNumber)

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

FIRST_PAGE_NUMBERback to summary
public static final int FIRST_PAGE_NUMBER

special page number which will sort before any other valid page number

FIRST_ROW_IDback to summary
public static final RowIdImpl FIRST_ROW_ID

special rowId which will sort before any other valid rowId

INVALID_ROW_NUMBERback to summary
public static final int INVALID_ROW_NUMBER

special row number representing an invalid row number

LAST_PAGE_NUMBERback to summary
public static final int LAST_PAGE_NUMBER

special page number which will sort after any other valid page number

LAST_ROW_IDback to summary
public static final RowIdImpl LAST_ROW_ID

special rowId which will sort after any other valid rowId

pageNumberback to summary
private final int pageNumber
rowNumberback to summary
private final int rowNumber
serialVersionUIDback to summary
private static final long serialVersionUID
typeback to summary
private final RowIdImpl.Type type

Constructor Detail

RowIdImplback to summary
public RowIdImpl(int pageNumber, int rowNumber)

Creates a new RowId instance.

Method Detail

compareToback to summary
public int compareTo(RowId other)

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.

Annotations
@Override
equalsback to summary
public boolean equals(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.

Annotations
@Override
getPageNumberback to summary
public int getPageNumber()
getRowNumberback to summary
public int getRowNumber()
getTypeback to summary
public RowIdImpl.Type getType()
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.
Annotations
@Override
isValidback to summary
public boolean isValid()

Returns true if this rowId potentially represents an actual row of data, false otherwise.

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.

Annotations
@Override
typeForPageNumberback to summary
private static RowIdImpl.Type typeForPageNumber(int pageNumber)
io.github.spannm.jackcess.impl back to summary

public final Enum RowIdImpl.Type

extends Enum<RowIdImpl.Type>
Class Inheritance

type attributes for RowIds which simplify comparisons

Field Summary

Modifier and TypeField and Description
public static final RowIdImpl.Type
ALWAYS_FIRST

comparable type indicating this RowId should always compare less than normal RowIds

public static final RowIdImpl.Type
ALWAYS_LAST

comparable type indicating this RowId should always compare greater than normal RowIds

public static final RowIdImpl.Type
NORMAL

comparable type indicating this RowId should always compare normally

Constructor Summary

AccessConstructor and Description
private
Type()

Method Summary

Modifier and TypeMethod and Description
public static RowIdImpl.Type
public static RowIdImpl.Type[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ALWAYS_FIRSTback to summary
public static final RowIdImpl.Type ALWAYS_FIRST

comparable type indicating this RowId should always compare less than normal RowIds

ALWAYS_LASTback to summary
public static final RowIdImpl.Type ALWAYS_LAST

comparable type indicating this RowId should always compare greater than normal RowIds

NORMALback to summary
public static final RowIdImpl.Type NORMAL

comparable type indicating this RowId should always compare normally

Constructor Detail

Typeback to summary
private Type()

Method Detail

valueOfback to summary
public static RowIdImpl.Type valueOf(String name)
valuesback to summary
public static RowIdImpl.Type[] values()