This is an automated email from the ASF dual-hosted git repository.
jmclean pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/gravitino.git
The following commit(s) were added to refs/heads/main by this push:
new 2516cdbd82 [#7207] fix: javadoc for :core (#7303)
2516cdbd82 is described below
commit 2516cdbd82da8463e2167e6887ad383b083cb060
Author: Yunchi Pang <[email protected]>
AuthorDate: Thu May 29 17:50:05 2025 -0700
[#7207] fix: javadoc for :core (#7303)
### What changes were proposed in this pull request?
fix javadoc for core.
### Why are the changes needed?
(Please clarify why the changes are needed. For instance,
1. If you propose a new API, clarify the use case for a new API.
2. If you fix a bug, describe the bug.)
Fix: #7207
### Does this PR introduce _any_ user-facing change?
(Please list the user-facing changes introduced by your change,
including
1. Change in user-facing APIs.
2. Addition or removal of property keys.)
### How was this patch tested?
(Please test your changes, and provide instructions on how to test it:
1. If you add a feature or fix a bug, add a test to cover your changes.
2. If you fix a flaky test, repeat it for many times to prove it works.)
---
.../gravitino/SupportsRelationOperations.java | 4 +-
.../org/apache/gravitino/audit/AuditLogWriter.java | 9 ++--
.../authorization/AccessControlDispatcher.java | 2 +
.../org/apache/gravitino/cache/EntityCache.java | 2 +
.../cache/SupportsRelationEntityCache.java | 2 +
.../gravitino/catalog/PartitionDispatcher.java | 2 +-
.../gravitino/connector/CatalogOperations.java | 1 +
.../gravitino/connector/PropertiesMetadata.java | 7 ++-
.../connector/authorization/BaseAuthorization.java | 3 ++
.../api/event/GetPartitionFailureEvent.java | 2 +
.../api/event/LinkModelVersionFailureEvent.java | 2 +
.../listener/api/event/ListModelVersionsEvent.java | 3 +-
.../api/event/PartitionExistsFailureEvent.java | 1 +
.../api/event/RegisterAndLinkModelEvent.java | 2 +-
.../apache/gravitino/listener/api/info/Either.java | 2 +
.../api/info/partitions/PartitionInfo.java | 4 +-
.../org/apache/gravitino/meta/CatalogEntity.java | 6 ++-
.../gravitino/storage/relational/JDBCDatabase.java | 2 +-
.../storage/relational/RelationalBackend.java | 6 +++
.../converters/SQLExceptionConverter.java | 1 +
.../storage/relational/session/SqlSessions.java | 1 +
.../storage/relational/utils/POConverters.java | 59 ++++++++++++++--------
.../org/apache/gravitino/tag/TagDispatcher.java | 2 +
23 files changed, 93 insertions(+), 32 deletions(-)
diff --git
a/core/src/main/java/org/apache/gravitino/SupportsRelationOperations.java
b/core/src/main/java/org/apache/gravitino/SupportsRelationOperations.java
index d203b94deb..dad992412d 100644
--- a/core/src/main/java/org/apache/gravitino/SupportsRelationOperations.java
+++ b/core/src/main/java/org/apache/gravitino/SupportsRelationOperations.java
@@ -42,8 +42,9 @@ public interface SupportsRelationOperations {
/**
* List the entities according to a given entity in a specific relation.
*
+ * @param <E> The type of entities returned.
* @param relType The type of relation.
- * @param nameIdentifier The given entity identifier
+ * @param nameIdentifier The given entity identifier.
* @param identType The given entity type.
* @return The list of entities
* @throws IOException When occurs storage issues, it will throw IOException.
@@ -56,6 +57,7 @@ public interface SupportsRelationOperations {
/**
* List the entities according to a given entity in a specific relation.
*
+ * @param <E> the type of entities returned.
* @param relType The type of relation.
* @param nameIdentifier The given entity identifier
* @param identType The given entity type.
diff --git a/core/src/main/java/org/apache/gravitino/audit/AuditLogWriter.java
b/core/src/main/java/org/apache/gravitino/audit/AuditLogWriter.java
index d68fc72c9e..edc796da81 100644
--- a/core/src/main/java/org/apache/gravitino/audit/AuditLogWriter.java
+++ b/core/src/main/java/org/apache/gravitino/audit/AuditLogWriter.java
@@ -35,21 +35,22 @@ public interface AuditLogWriter extends Closeable {
/**
* Initialize the writer with the given configuration.
*
- * @param properties
+ * @param formatter formatter of type {@link Formatter} used to format the
output
+ * @param properties map of configuration properties
*/
void init(Formatter formatter, Map<String, String> properties);
/**
* Write the audit event to storage.
*
- * @param auditLog
+ * @param auditLog the {@link AuditLog} instance representing the event to
be written
*/
void doWrite(AuditLog auditLog);
/**
* Write the audit event to storage.
*
- * @param event
+ * @param event the audit {@link Event} to be written
*/
default void write(Event event) {
doWrite(getFormatter().format(event));
@@ -59,7 +60,7 @@ public interface AuditLogWriter extends Closeable {
* Define the name of the writer, which related to audit writer
configuration. Audit log writer
* configuration start with: gravitino.audit.log.writer.${name}.*
*
- * @return
+ * @return the name of the writer
*/
String name();
}
diff --git
a/core/src/main/java/org/apache/gravitino/authorization/AccessControlDispatcher.java
b/core/src/main/java/org/apache/gravitino/authorization/AccessControlDispatcher.java
index 9aa2b3f52b..1b71443252 100644
---
a/core/src/main/java/org/apache/gravitino/authorization/AccessControlDispatcher.java
+++
b/core/src/main/java/org/apache/gravitino/authorization/AccessControlDispatcher.java
@@ -285,6 +285,7 @@ public interface AccessControlDispatcher {
/**
* Grant privileges to a role.
*
+ * @param metalake The name of the Metalake.
* @param role The name of the role.
* @param privileges The privileges to grant.
* @param object The object is associated with privileges to grant.
@@ -300,6 +301,7 @@ public interface AccessControlDispatcher {
/**
* Revoke privileges from a role.
*
+ * @param metalake The name if the Metalake.
* @param role The name of the role.
* @param privileges The privileges to revoke.
* @param object The object is associated with privileges to revoke.
diff --git a/core/src/main/java/org/apache/gravitino/cache/EntityCache.java
b/core/src/main/java/org/apache/gravitino/cache/EntityCache.java
index 4779385bd5..8ccdb6c146 100644
--- a/core/src/main/java/org/apache/gravitino/cache/EntityCache.java
+++ b/core/src/main/java/org/apache/gravitino/cache/EntityCache.java
@@ -44,6 +44,8 @@ public interface EntityCache extends
SupportsEntityStoreCache, SupportsRelationE
* Executes the given action within a cache context.
*
* @param action The action to cache
+ * @param <E> The type of exception that may be thrown
+ * @throws E if the action throws an exception of type E
*/
<E extends Exception> void withCacheLock(ThrowingRunnable<E> action) throws
E;
diff --git
a/core/src/main/java/org/apache/gravitino/cache/SupportsRelationEntityCache.java
b/core/src/main/java/org/apache/gravitino/cache/SupportsRelationEntityCache.java
index b504fdac96..7f5616a550 100644
---
a/core/src/main/java/org/apache/gravitino/cache/SupportsRelationEntityCache.java
+++
b/core/src/main/java/org/apache/gravitino/cache/SupportsRelationEntityCache.java
@@ -43,6 +43,8 @@ public interface SupportsRelationEntityCache {
* @param relType The relation type to find related entities for
* @return A list of related entities, or an empty list if none are found
* @param <E> The class of the related entities
+ * @throws IOException if an I/O error occurs while loading related entities
from the underlying
+ * {@link EntityStore}
*/
<E extends Entity & HasIdentifier> List<E> getOrLoad(
NameIdentifier ident, Entity.EntityType type,
SupportsRelationOperations.Type relType)
diff --git
a/core/src/main/java/org/apache/gravitino/catalog/PartitionDispatcher.java
b/core/src/main/java/org/apache/gravitino/catalog/PartitionDispatcher.java
index b3cd8f3883..e803805882 100644
--- a/core/src/main/java/org/apache/gravitino/catalog/PartitionDispatcher.java
+++ b/core/src/main/java/org/apache/gravitino/catalog/PartitionDispatcher.java
@@ -53,7 +53,7 @@ public interface PartitionDispatcher {
* @param tableIdent The identifier of the table.
* @param partitionName The name of the partition.
* @return The partition.
- * @throws NoSuchPartitionException
+ * @throws NoSuchPartitionException if no partition with the specified name
exists in the table
*/
Partition getPartition(NameIdentifier tableIdent, String partitionName)
throws NoSuchPartitionException;
diff --git
a/core/src/main/java/org/apache/gravitino/connector/CatalogOperations.java
b/core/src/main/java/org/apache/gravitino/connector/CatalogOperations.java
index 3d7f944d76..e617904da3 100644
--- a/core/src/main/java/org/apache/gravitino/connector/CatalogOperations.java
+++ b/core/src/main/java/org/apache/gravitino/connector/CatalogOperations.java
@@ -58,6 +58,7 @@ public interface CatalogOperations extends Closeable {
* @param provider the provider of the catalog.
* @param comment the comment of the catalog.
* @param properties the properties of the catalog.
+ * @throws Exception if connection fails.
*/
void testConnection(
NameIdentifier catalogIdent,
diff --git
a/core/src/main/java/org/apache/gravitino/connector/PropertiesMetadata.java
b/core/src/main/java/org/apache/gravitino/connector/PropertiesMetadata.java
index 46df3dd86f..ad40589cb3 100644
--- a/core/src/main/java/org/apache/gravitino/connector/PropertiesMetadata.java
+++ b/core/src/main/java/org/apache/gravitino/connector/PropertiesMetadata.java
@@ -94,7 +94,12 @@ public interface PropertiesMetadata {
return
getPropertyPrefixEntry(propertyName).map(PropertyEntry::isHidden).orElse(false);
}
- /** @return true if the property is existed, false otherwise. */
+ /**
+ * Checks whether the specified property exists.
+ *
+ * @param propertyName the name of the property to check for existence
+ * @return true if the property exists, false otherwise
+ */
default boolean containsProperty(String propertyName) {
return getNonPrefixEntry(propertyName).isPresent()
|| getPropertyPrefixEntry(propertyName).isPresent();
diff --git
a/core/src/main/java/org/apache/gravitino/connector/authorization/BaseAuthorization.java
b/core/src/main/java/org/apache/gravitino/connector/authorization/BaseAuthorization.java
index 740f808e4d..fa90fbd201 100644
---
a/core/src/main/java/org/apache/gravitino/connector/authorization/BaseAuthorization.java
+++
b/core/src/main/java/org/apache/gravitino/connector/authorization/BaseAuthorization.java
@@ -50,6 +50,9 @@ public abstract class BaseAuthorization<T extends
BaseAuthorization>
* The child class should implement this method to provide a specific
AuthorizationPlugin instance
* regarding that authorization. <br>
*
+ * @param metalake the identifier of the metalake environment
+ * @param catalogProvider the identifier of the catalog provider within the
metadata lake
+ * @param config a map of configuration properties required by the plugin
* @return A new instance of AuthorizationHook.
*/
public abstract AuthorizationPlugin newPlugin(
diff --git
a/core/src/main/java/org/apache/gravitino/listener/api/event/GetPartitionFailureEvent.java
b/core/src/main/java/org/apache/gravitino/listener/api/event/GetPartitionFailureEvent.java
index b0921015b6..663b05552b 100644
---
a/core/src/main/java/org/apache/gravitino/listener/api/event/GetPartitionFailureEvent.java
+++
b/core/src/main/java/org/apache/gravitino/listener/api/event/GetPartitionFailureEvent.java
@@ -38,6 +38,8 @@ public final class GetPartitionFailureEvent extends
PartitionFailureEvent {
* @param identifier The identifier of the partition that was attempted to
be gotten.
* @param exception The exception that was thrown during the get partition
operation, providing
* insight into what went wrong.
+ * @param partitionName The name of the partition that was being retrieved
when the failure
+ * occurred.
*/
public GetPartitionFailureEvent(
String user, NameIdentifier identifier, Exception exception, String
partitionName) {
diff --git
a/core/src/main/java/org/apache/gravitino/listener/api/event/LinkModelVersionFailureEvent.java
b/core/src/main/java/org/apache/gravitino/listener/api/event/LinkModelVersionFailureEvent.java
index e47a853f38..d6b982aa1a 100644
---
a/core/src/main/java/org/apache/gravitino/listener/api/event/LinkModelVersionFailureEvent.java
+++
b/core/src/main/java/org/apache/gravitino/listener/api/event/LinkModelVersionFailureEvent.java
@@ -37,6 +37,8 @@ public class LinkModelVersionFailureEvent extends
ModelFailureEvent {
* @param user The username of the individual who initiated the operation to
link a model version.
* @param identifier The identifier of the model that was involved in the
failed operation.
* @param exception The exception encountered during the attempt to link a
model version.
+ * @param linkModelVersionRequest The original {@link ModelVersionInfo}
request containing details
+ * of the model version link operation that failed.
*/
public LinkModelVersionFailureEvent(
String user,
diff --git
a/core/src/main/java/org/apache/gravitino/listener/api/event/ListModelVersionsEvent.java
b/core/src/main/java/org/apache/gravitino/listener/api/event/ListModelVersionsEvent.java
index 04974964ac..d6aa2be3c1 100644
---
a/core/src/main/java/org/apache/gravitino/listener/api/event/ListModelVersionsEvent.java
+++
b/core/src/main/java/org/apache/gravitino/listener/api/event/ListModelVersionsEvent.java
@@ -30,7 +30,8 @@ public class ListModelVersionsEvent extends ModelEvent {
* identifier.
*
* @param user The username of the individual who initiated the model
version listing.
- * @param identifier The unique identifier of the model that it's version
was listed.
+ * @param identifier The unique identifier of the model whose versions were
listed.
+ * @param versions An array of version numbers of the model.
*/
public ListModelVersionsEvent(String user, NameIdentifier identifier, int[]
versions) {
super(user, identifier);
diff --git
a/core/src/main/java/org/apache/gravitino/listener/api/event/PartitionExistsFailureEvent.java
b/core/src/main/java/org/apache/gravitino/listener/api/event/PartitionExistsFailureEvent.java
index de937a7f21..8fab4fc48d 100644
---
a/core/src/main/java/org/apache/gravitino/listener/api/event/PartitionExistsFailureEvent.java
+++
b/core/src/main/java/org/apache/gravitino/listener/api/event/PartitionExistsFailureEvent.java
@@ -38,6 +38,7 @@ public final class PartitionExistsFailureEvent extends
PartitionFailureEvent {
* @param identifier The identifier of the partition that was attempted to
be gotten.
* @param exception The exception that was thrown during the partition exist
check operation,
* providing insight into what went wrong.
+ * @param partitionName The name of the partition being checked for
existence.
*/
public PartitionExistsFailureEvent(
String user, NameIdentifier identifier, Exception exception, String
partitionName) {
diff --git
a/core/src/main/java/org/apache/gravitino/listener/api/event/RegisterAndLinkModelEvent.java
b/core/src/main/java/org/apache/gravitino/listener/api/event/RegisterAndLinkModelEvent.java
index f3c5e1c1fd..80abd1bdca 100644
---
a/core/src/main/java/org/apache/gravitino/listener/api/event/RegisterAndLinkModelEvent.java
+++
b/core/src/main/java/org/apache/gravitino/listener/api/event/RegisterAndLinkModelEvent.java
@@ -60,7 +60,7 @@ public class RegisterAndLinkModelEvent extends ModelEvent {
/**
* Retrieves the uri of the linked model version.
*
- * @return
+ * @return the uri of the linked model version
*/
public String uri() {
return uri;
diff --git
a/core/src/main/java/org/apache/gravitino/listener/api/info/Either.java
b/core/src/main/java/org/apache/gravitino/listener/api/info/Either.java
index b9b51e00b2..4972ca4c37 100644
--- a/core/src/main/java/org/apache/gravitino/listener/api/info/Either.java
+++ b/core/src/main/java/org/apache/gravitino/listener/api/info/Either.java
@@ -88,6 +88,7 @@ public final class Either<L, R> {
* @param value Left value
* @param <L> Left type
* @param <R> Right type
+ * @return an Either instance with left value
*/
public static <L, R> Either<L, R> left(L value) {
Preconditions.checkArgument(value != null, "Left value cannot be null");
@@ -100,6 +101,7 @@ public final class Either<L, R> {
* @param value Right value
* @param <L> Left type
* @param <R> Right type
+ * @return an Either instance with right value
*/
public static <L, R> Either<L, R> right(R value) {
Preconditions.checkArgument(value != null, "Right value cannot be null");
diff --git
a/core/src/main/java/org/apache/gravitino/listener/api/info/partitions/PartitionInfo.java
b/core/src/main/java/org/apache/gravitino/listener/api/info/partitions/PartitionInfo.java
index 11fe56a012..a5048877ac 100644
---
a/core/src/main/java/org/apache/gravitino/listener/api/info/partitions/PartitionInfo.java
+++
b/core/src/main/java/org/apache/gravitino/listener/api/info/partitions/PartitionInfo.java
@@ -70,7 +70,9 @@ public abstract class PartitionInfo {
/**
* Returns the instance of the PartitionInfo.
*
- * @return A instance of the PartitionInfo
+ * @param partition the source {@link Partition} to convert into a {@link
PartitionInfo}
+ * @return A instance of the {@code PartitionInfo}
+ * @throws GravitinoRuntimeException if the partition type is unrecognized
*/
public static PartitionInfo of(Partition partition) {
if (partition instanceof IdentityPartition) {
diff --git a/core/src/main/java/org/apache/gravitino/meta/CatalogEntity.java
b/core/src/main/java/org/apache/gravitino/meta/CatalogEntity.java
index b035578cd7..d741370a3a 100644
--- a/core/src/main/java/org/apache/gravitino/meta/CatalogEntity.java
+++ b/core/src/main/java/org/apache/gravitino/meta/CatalogEntity.java
@@ -133,7 +133,11 @@ public class CatalogEntity implements Entity, Auditable,
HasIdentifier {
return EntityType.CATALOG;
}
- /** Convert the catalog entity to a {@link CatalogInfo} instance. */
+ /**
+ * Converts the catalog entity to a {@link CatalogInfo} instance.
+ *
+ * @return a new {@link CatalogInfo} instance
+ */
public CatalogInfo toCatalogInfo() {
return new CatalogInfo(id, name, type, provider, comment, properties,
auditInfo, namespace);
}
diff --git
a/core/src/main/java/org/apache/gravitino/storage/relational/JDBCDatabase.java
b/core/src/main/java/org/apache/gravitino/storage/relational/JDBCDatabase.java
index 8c7989d617..c0de0d727b 100644
---
a/core/src/main/java/org/apache/gravitino/storage/relational/JDBCDatabase.java
+++
b/core/src/main/java/org/apache/gravitino/storage/relational/JDBCDatabase.java
@@ -27,7 +27,7 @@ public interface JDBCDatabase extends Closeable {
* Initializes the Relational database environment with the provided
configuration.
*
* @param config The configuration for the database backend.
- * @throws RuntimeException
+ * @throws RuntimeException if any other error occurs during setup
*/
void initialize(Config config);
}
diff --git
a/core/src/main/java/org/apache/gravitino/storage/relational/RelationalBackend.java
b/core/src/main/java/org/apache/gravitino/storage/relational/RelationalBackend.java
index cae0c7b4d3..95a58e86fd 100644
---
a/core/src/main/java/org/apache/gravitino/storage/relational/RelationalBackend.java
+++
b/core/src/main/java/org/apache/gravitino/storage/relational/RelationalBackend.java
@@ -46,6 +46,7 @@ public interface RelationalBackend
/**
* Lists the entities associated with the given parent namespace and
entityType
*
+ * @param <E> The entity type.
* @param namespace The parent namespace of these entities.
* @param entityType The type of these entities.
* @param allFields Some fields may have a relatively high acquisition cost,
EntityStore provide
@@ -75,6 +76,7 @@ public interface RelationalBackend
/**
* Stores the entity, possibly overwriting an existing entity if specified.
*
+ * @param <E> The type of the entity returned.
* @param e The entity which need be stored.
* @param overwritten If true, overwrites the existing value.
* @throws EntityAlreadyExistsException If the entity already exists and
overwrite is false.
@@ -86,8 +88,11 @@ public interface RelationalBackend
/**
* Updates the entity.
*
+ * @param <E> The entity type.
* @param ident The identifier of the entity which need be stored.
* @param entityType The type of the entity.
+ * @param updater A {@link Function} that takes the current entity instance
and returns and
+ * returns the updated instance.
* @return The entity after updating.
* @throws NoSuchEntityException If the entity is not exist.
* @throws IOException If the entity is failed to update.
@@ -99,6 +104,7 @@ public interface RelationalBackend
/**
* Retrieves the entity associated with the identifier and the entity type.
*
+ * @param <E> The type of the entity returned.
* @param ident The identifier of the entity.
* @param entityType The type of the entity.
* @return The entity associated with the identifier and the entity type, or
null if the key does
diff --git
a/core/src/main/java/org/apache/gravitino/storage/relational/converters/SQLExceptionConverter.java
b/core/src/main/java/org/apache/gravitino/storage/relational/converters/SQLExceptionConverter.java
index b8c4b488c9..d1c7b44af5 100644
---
a/core/src/main/java/org/apache/gravitino/storage/relational/converters/SQLExceptionConverter.java
+++
b/core/src/main/java/org/apache/gravitino/storage/relational/converters/SQLExceptionConverter.java
@@ -30,6 +30,7 @@ public interface SQLExceptionConverter {
* @param sqlException The sql exception to map
* @param type The type of the entity
* @param name The name of the entity
+ * @throws IOException if an I/O error occurs during exception conversion
*/
void toGravitinoException(SQLException sqlException, Entity.EntityType type,
String name)
throws IOException;
diff --git
a/core/src/main/java/org/apache/gravitino/storage/relational/session/SqlSessions.java
b/core/src/main/java/org/apache/gravitino/storage/relational/session/SqlSessions.java
index c538431d34..def9c5e43f 100644
---
a/core/src/main/java/org/apache/gravitino/storage/relational/session/SqlSessions.java
+++
b/core/src/main/java/org/apache/gravitino/storage/relational/session/SqlSessions.java
@@ -104,6 +104,7 @@ public final class SqlSessions {
/**
* Get the Mapper object from the SqlSession object.
*
+ * @param <T> the type of the mapper interface.
* @param className the class name of the Mapper object.
* @return the Mapper object.
*/
diff --git
a/core/src/main/java/org/apache/gravitino/storage/relational/utils/POConverters.java
b/core/src/main/java/org/apache/gravitino/storage/relational/utils/POConverters.java
index e8ae898a7c..905663ecc5 100644
---
a/core/src/main/java/org/apache/gravitino/storage/relational/utils/POConverters.java
+++
b/core/src/main/java/org/apache/gravitino/storage/relational/utils/POConverters.java
@@ -182,8 +182,10 @@ public class POConverters {
/**
* Initialize CatalogPO
*
- * @param catalogEntity CatalogEntity object
- * @return CatalogPO object with version initialized
+ * @param catalogEntity the {@link CatalogEntity} containing source metadata
for the catalog
+ * @param metalakeId the identifier of the metalake environment to which
this catalog belongs
+ * @return {@link CatalogPO} object with version initialized
+ * @throws RuntimeException if JSON serialization of the entity fails
*/
public static CatalogPO initializeCatalogPOWithVersion(
CatalogEntity catalogEntity, Long metalakeId) {
@@ -210,9 +212,11 @@ public class POConverters {
/**
* Update CatalogPO version
*
- * @param oldCatalogPO the old CatalogPO object
- * @param newCatalog the new CatalogEntity object
- * @return CatalogPO object with updated version
+ * @param oldCatalogPO the existing {@link CatalogPO} containing the version
to preserve
+ * @param newCatalog the {@link CatalogEntity} with updated catalog metadata
+ * @param metalakeId the identifier of the metalake environment for this
catalog
+ * @return {@code CatalogPO} object with updated version
+ * @throws RuntimeException if JSON serialization of the entity fails
*/
public static CatalogPO updateCatalogPOWithVersion(
CatalogPO oldCatalogPO, CatalogEntity newCatalog, Long metalakeId) {
@@ -281,8 +285,10 @@ public class POConverters {
/**
* Initialize SchemaPO
*
- * @param schemaEntity SchemaEntity object
- * @return CatalogPO object with version initialized
+ * @param schemaEntity the {@link SchemaEntity} containing source data for
the PO object
+ * @param builder the {@link SchemaPO.Builder} used to assemble the {@link
SchemaPO}
+ * @return {@code CatalogPO} object with version initialized
+ * @throws RuntimeException if JSON serialization of the entity fails
*/
public static SchemaPO initializeSchemaPOWithVersion(
SchemaEntity schemaEntity, SchemaPO.Builder builder) {
@@ -370,8 +376,10 @@ public class POConverters {
/**
* Initialize TablePO
*
- * @param tableEntity TableEntity object
- * @return TablePO object with version initialized
+ * @param tableEntity the {@link TableEntity} containing source data for the
PO object
+ * @param builder the {@link TablePO.Builder} used to assemble the {@link
TablePO}
+ * @return {@code TablePO} object with version initialized
+ * @throws RuntimeException if JSON serialization of the entity fails
*/
public static TablePO initializeTablePOWithVersion(
TableEntity tableEntity, TablePO.Builder builder) {
@@ -538,8 +546,10 @@ public class POConverters {
/**
* Initialize FilesetPO
*
- * @param filesetEntity FilesetEntity object
- * @return FilesetPO object with version initialized
+ * @param filesetEntity the source {@link FilesetEntity} object
+ * @param builder the {@link FilesetPO.Builder} used to assemble the {@link
FilesetPO}
+ * @return {@code FilesetPO} object with version initialized
+ * @throws RuntimeException if JSON serialization of the entity fails
*/
public static FilesetPO initializeFilesetPOWithVersion(
FilesetEntity filesetEntity, FilesetPO.Builder builder) {
@@ -580,9 +590,12 @@ public class POConverters {
/**
* Update FilesetPO version
*
- * @param oldFilesetPO the old FilesetPO object
- * @param newFileset the new FilesetEntity object
- * @return FilesetPO object with updated version
+ * @param oldFilesetPO the existing {@link FilesetPO} containing the current
and last version data
+ * @param newFileset the {@link FilesetEntity} with updated metadata and
storage locations
+ * @param needUpdateVersion true to increment and update version fields;
false to keep versions
+ * unchanged
+ * @return {@code FilesetPO} object with updated version
+ * @throws RuntimeException if JSON serialization of properties fails
*/
public static FilesetPO updateFilesetPOWithVersion(
FilesetPO oldFilesetPO, FilesetEntity newFileset, boolean
needUpdateVersion) {
@@ -771,8 +784,10 @@ public class POConverters {
/**
* Initialize UserPO
*
- * @param userEntity UserEntity object
- * @return UserPO object with version initialized
+ * @param userEntity the {@link UserEntity} containing source data for the
PO object
+ * @param builder the {@link UserPO.Builder} used to assemble the {@link
UserPO}
+ * @return {@code UserPO} object with version initialized
+ * @throws RuntimeException if JSON serialization of the entity fails
*/
public static UserPO initializeUserPOWithVersion(UserEntity userEntity,
UserPO.Builder builder) {
try {
@@ -1017,8 +1032,10 @@ public class POConverters {
/**
* Initialize RolePO
*
- * @param roleEntity RoleEntity object
- * @return RolePO object with version initialized
+ * @param roleEntity the {@link RoleEntity} containing source data for the
PO object
+ * @param builder the {@link RolePO.Builder} used to assemble the {@link
RolePO}
+ * @return {@code RolePO} object with version initialized
+ * @throws RuntimeException if JSON serialization of the entity fails
*/
public static RolePO initializeRolePOWithVersion(RoleEntity roleEntity,
RolePO.Builder builder) {
try {
@@ -1039,8 +1056,10 @@ public class POConverters {
/**
* Initialize GroupPO
*
- * @param groupEntity GroupEntity object
- * @return GroupPO object with version initialized
+ * @param groupEntity the {@link GroupEntity} containing source data for the
PO object
+ * @param builder the {@link GroupPO.Builder} used to assemble the {@link
GroupPO}
+ * @return {@code GroupPO} object with version initialized
+ * @throws RuntimeException if JSON serialization of the entity fails
*/
public static GroupPO initializeGroupPOWithVersion(
GroupEntity groupEntity, GroupPO.Builder builder) {
diff --git a/core/src/main/java/org/apache/gravitino/tag/TagDispatcher.java
b/core/src/main/java/org/apache/gravitino/tag/TagDispatcher.java
index 0070e27179..6e0276703d 100644
--- a/core/src/main/java/org/apache/gravitino/tag/TagDispatcher.java
+++ b/core/src/main/java/org/apache/gravitino/tag/TagDispatcher.java
@@ -31,6 +31,7 @@ public interface TagDispatcher {
/**
* List all the tag names for the specific object.
*
+ * @param metalake object identifier
* @return The list of tag names.
*/
String[] listTags(String metalake);
@@ -38,6 +39,7 @@ public interface TagDispatcher {
/**
* List all the tags with details for the specific object.
*
+ * @param metalake object identifier
* @return The list of tags.
*/
Tag[] listTagsInfo(String metalake);
