Skip to content

Commit

Permalink
Javadoc and test naming improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
lutovich committed Jul 1, 2016
1 parent 9c35ed1 commit cdf3d51
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
Expand Up @@ -46,8 +46,17 @@ public interface TransactionIdStore
// Tx id counting starting from this value (this value means no transaction ever committed) // Tx id counting starting from this value (this value means no transaction ever committed)
long BASE_TX_ID = 1; long BASE_TX_ID = 1;
long BASE_TX_CHECKSUM = 0; long BASE_TX_CHECKSUM = 0;
long BASE_TX_COMMIT_TIMESTAMP = 0; // TODO: JAVADOCSA THIS
long UNKNOWN_TX_COMMIT_TIMESTAMP = 1; // TODO: JAVADOCSA THIS /**
* Timestamp value used initially for an empty database.
*/
long BASE_TX_COMMIT_TIMESTAMP = 0;

/**
* Timestamp value used when record in the metadata store is not present and there are no transactions in logs.
*/
long UNKNOWN_TX_COMMIT_TIMESTAMP = 1;

long BASE_TX_LOG_VERSION = 0; long BASE_TX_LOG_VERSION = 0;
long BASE_TX_LOG_BYTE_OFFSET = LOG_HEADER_SIZE; long BASE_TX_LOG_BYTE_OFFSET = LOG_HEADER_SIZE;


Expand All @@ -64,7 +73,7 @@ public interface TransactionIdStore
* seen given to this method will be visible in {@link #getLastCommittedTransactionId()}. * seen given to this method will be visible in {@link #getLastCommittedTransactionId()}.
* @param transactionId the applied transaction id. * @param transactionId the applied transaction id.
* @param checksum checksum of the transaction. * @param checksum checksum of the transaction.
* @param commitTimestamp * @param commitTimestamp the timestamp of the transaction commit.
*/ */
void transactionCommitted( long transactionId, long checksum, long commitTimestamp ); void transactionCommitted( long transactionId, long checksum, long commitTimestamp );


Expand Down Expand Up @@ -101,7 +110,7 @@ public interface TransactionIdStore
* Perhaps this shouldn't be exposed like this? * Perhaps this shouldn't be exposed like this?
* @param transactionId transaction id that will be the last closed/committed id. * @param transactionId transaction id that will be the last closed/committed id.
* @param checksum checksum of the transaction. * @param checksum checksum of the transaction.
* @param commitTimestamp * @param commitTimestamp the timestamp of the transaction commit.
* @param byteOffset offset in the log file where the committed entry has been written. * @param byteOffset offset in the log file where the committed entry has been written.
* @param logVersion version of log the committed entry has been written into. * @param logVersion version of log the committed entry has been written into.
*/ */
Expand Down
Expand Up @@ -190,7 +190,7 @@ public void shouldRenameFiles() throws IOException


@Test @Test
@SuppressWarnings( "unchecked" ) @SuppressWarnings( "unchecked" )
public void getTransactionInformation() throws IOException public void transactionInformationRetrievedFromCommitEntries() throws IOException
{ {
FileSystemAbstraction fs = mock( FileSystemAbstraction.class ); FileSystemAbstraction fs = mock( FileSystemAbstraction.class );
File logFile = new File( LegacyLogFilenames.getLegacyLogFilename( 1 ) ); File logFile = new File( LegacyLogFilenames.getLegacyLogFilename( 1 ) );
Expand Down

0 comments on commit cdf3d51

Please sign in to comment.