Skip to content

Commit 3f5f323

Browse files
committed
MCR-3126 fix javadoc
1 parent e21d0a6 commit 3f5f323

File tree

2 files changed

+16
-3
lines changed

2 files changed

+16
-3
lines changed

mycore-ocfl/src/main/java/org/mycore/ocfl/niofs/MCROCFLFileSystemTransaction.java

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,12 @@
3333
import org.mycore.ocfl.niofs.storage.MCROCFLTransactionalTempFileStorage;
3434

3535
/**
36-
* Manages transactions for the OCFL file system, implementing {@link MCRPersistenceTransaction}.
37-
* Provides methods to begin, commit, rollback, and check the status of transactions.
36+
* Manages transactions for the OCFL (Oxford Common File Layout) file system within MyCoRe,
37+
* implementing {@link MCRPersistenceTransaction}. This class coordinates the lifecycle of a transaction,
38+
* including beginning, committing, and rolling back changes, ensuring data consistency in the OCFL file system.
39+
* <p>
40+
* Each transaction is uniquely identified by an ID, tracked in a thread-local variable for
41+
* thread-safe operations.
3842
*/
3943
public class MCROCFLFileSystemTransaction implements MCRPersistenceTransaction {
4044

@@ -146,10 +150,20 @@ public int getCommitPriority() {
146150
return 5000;
147151
}
148152

153+
/**
154+
* Retrieves the current transaction ID, if any.
155+
*
156+
* @return the transaction ID, or {@code null} if no transaction is active.
157+
*/
149158
public static Long getTransactionId() {
150159
return TRANSACTION_ID.get();
151160
}
152161

162+
/**
163+
* Checks if a transaction is currently active.
164+
*
165+
* @return {@code true} if a transaction is active, {@code false} otherwise.
166+
*/
153167
public static boolean isActive() {
154168
return MCRTransactionManager.isActive(MCROCFLFileSystemTransaction.class);
155169
}

mycore-ocfl/src/main/java/org/mycore/ocfl/util/MCROCFLVersionHelper.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
* <p>
2828
* This class provides utilities for mapping versioning messages (e.g., "Created", "Updated", "Deleted")
2929
* to their corresponding version types in the OCFL metadata.
30-
* </p>
3130
*/
3231
public class MCROCFLVersionHelper {
3332

0 commit comments

Comments
 (0)