JGit 7.2.0.202503040940-r · org.eclipse.jgit.internal.storage.reftable.RefCursor

Access	Constructor and Description
public	RefCursor()

Method Summary

Modifier and Type	Method and Description
public abstract void	close() Redeclares java.lang.AutoCloseable.close. Closes this resource, relinquishing any underlying resources.
public abstract Ref	Returns: reference at the current position. getRef() Get reference at the current position.
public abstract boolean	Returns: `true` if there is another result. next() Check if another reference is available.
public abstract void	seekPastPrefix(String prefix that should be skipped. All previous refs before it will be skipped. prefixName) Seeks forward to the first ref record lexicographically beyond `prefixName` that doesn't start with `prefixName`.
public boolean	Returns: `true` if the current reference was deleted. wasDeleted() Whether the current reference was deleted.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

RefCursor	back to summary
public RefCursor()

Method Detail

close back to summary

close	back to summary
public abstract void close() Redeclares java.lang.AutoCloseable.close. Doc from java.lang.AutoCloseable.close. Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the `try`-with-resources statement. Annotations @Override

public abstract void close()

Redeclares java.lang.AutoCloseable.close.

Doc from java.lang.AutoCloseable.close.

Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the try-with-resources statement.

Annotations

@Override

getRef	back to summary
public abstract Ref getRef() Get reference at the current position. Returns:Ref reference at the current position.

getRef

back to summary

public abstract Ref getRef()

Get reference at the current position.

Returns:Ref: reference at the current position.

next back to summary

next	back to summary
public abstract boolean next() throws IOException Check if another reference is available. Returns:boolean `true` if there is another result. Exceptions IOException: references cannot be read.

public abstract boolean next() throws IOException

Check if another reference is available.

Returns:boolean

true if there is another result.

Exceptions

IOException:: references cannot be read.

seekPastPrefix back to summary

seekPastPrefix	back to summary
public abstract void seekPastPrefix(String prefixName) throws IOException Seeks forward to the first ref record lexicographically beyond `prefixName` that doesn't start with `prefixName`. If there are no more results, skipping some refs won't add new results. E.g if we create a RefCursor that returns only results with a specific prefix, skipping that prefix won't give results that are not part of the original prefix. Parameters prefixName:String prefix that should be skipped. All previous refs before it will be skipped. Exceptions IOException: references cannot be read.

public abstract void seekPastPrefix(String prefixName) throws IOException

Seeks forward to the first ref record lexicographically beyond prefixName that doesn't start with prefixName. If there are no more results, skipping some refs won't add new results. E.g if we create a RefCursor that returns only results with a specific prefix, skipping that prefix won't give results that are not part of the original prefix.

Parameters

prefixName:String: prefix that should be skipped. All previous refs before it will be skipped.

Exceptions

IOException:: references cannot be read.

wasDeleted back to summary

wasDeleted	back to summary
public boolean wasDeleted() Whether the current reference was deleted. Returns:boolean `true` if the current reference was deleted.

public boolean wasDeleted()

Whether the current reference was deleted.

Returns:boolean: true if the current reference was deleted.

public abstract Class RefCursor

Constructor Summary

Method Summary

Constructor Detail

Method Detail