From d18faf5850b1f969613fd4764b4a941d6cb2c352 Mon Sep 17 00:00:00 2001 From: Garrett Jones Date: Thu, 12 Jul 2018 09:36:36 -0700 Subject: [PATCH] Fixing BigTable javadoc errors --- .../bigtable/admin/v2/TableAdminClient.java | 34 +++---------------- .../bigtable/admin/v2/models/GCRules.java | 17 ---------- .../admin/v2/models/TableAdminResponses.java | 26 ++------------ 3 files changed, 7 insertions(+), 70 deletions(-) diff --git a/google-cloud-clients/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/TableAdminClient.java b/google-cloud-clients/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/TableAdminClient.java index 3351fc09bce4..89f3ee6ccdb1 100644 --- a/google-cloud-clients/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/TableAdminClient.java +++ b/google-cloud-clients/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/TableAdminClient.java @@ -152,8 +152,6 @@ private TableAdminClient(InstanceName instanceName, BigtableTableAdminStub stub) /** * Gets the instanceName this client is associated to - * - * @return InstanceName */ public InstanceName getInstanceName() { return instanceName; @@ -179,7 +177,7 @@ public void close() { * } * * @param createTable - * @return Table - the newly created table + * @return the newly created table * @see CreateTable for createTable configurations */ public Table createTable(CreateTable createTable) { @@ -203,7 +201,7 @@ public Table createTable(CreateTable createTable) { * } * * @param createTable - * @return ApiFuture - the newly created table + * @return the newly created table * @see CreateTable for createTable configurations */ public ApiFuture
createTableAsync(CreateTable createTable) { @@ -240,7 +238,7 @@ public ApiFuture
createTableAsync(CreateTable createTable) { * } * * @param modifyFamily - * @return Table - Modified table + * @return the modified table * @see ModifyFamilies for modifyFamily options */ public Table modifyFamilies(ModifyFamilies modifyFamily) { @@ -279,7 +277,7 @@ public Table modifyFamilies(ModifyFamilies modifyFamily) { * } * * @param modifyFamily - * @return ApiFuture
- Modified table + * @return Modified table * @see ModifyFamilies for modifyFamily options */ public ApiFuture
modifyFamiliesAsync(ModifyFamilies modifyFamily) { @@ -334,7 +332,6 @@ public ApiFuture deleteTableAsync(String tableId) { * } * * @param tableId - * @return Table */ public Table getTable(String tableId) { com.google.bigtable.admin.v2.Table table = @@ -354,7 +351,6 @@ public Table getTable(String tableId) { * } * * @param tableId - * @return ApiFuture
*/ public ApiFuture
getTableAsync(String tableId) { return transformToTableResponse( @@ -371,9 +367,6 @@ public ApiFuture
getTableAsync(String tableId) { * client.listTables(); * } * } - * - * @param tableId - * @return List */ public List listTables() { ListTablesResponse listResp = this.stub.listTablesCallable().call(composeListTableRequest()); @@ -390,9 +383,6 @@ public List listTables() { * client.listTablesAsync(); * } * } - * - * @param tableId - * @return List */ public ApiFuture> listTablesAsync() { ApiFuture listResp = @@ -512,7 +502,6 @@ public void dropAllRows(String tableId) { * } * * @param tableId - * @return ApiFuture */ public ApiFuture dropAllRowsAsync(String tableId) { return transformToVoid( @@ -534,7 +523,6 @@ public ApiFuture dropAllRowsAsync(String tableId) { * } * * @param tableId - * @return ConsistencyToken */ public ConsistencyToken generateConsistencyToken(String tableId) { return TableAdminResponses.convertTokenResponse( @@ -556,7 +544,6 @@ public ConsistencyToken generateConsistencyToken(String tableId) { * } * * @param tableId - * @return ApiFuture */ public ApiFuture generateConsistencyTokenAsync(String tableId) { ApiFuture tokenResp = @@ -587,7 +574,6 @@ public ConsistencyToken apply(GenerateConsistencyTokenResponse input) { * * @param tableId * @param token - * @return boolean */ public boolean isConsistent(String tableId, ConsistencyToken token) { return stub.checkConsistencyCallable() @@ -608,7 +594,6 @@ public boolean isConsistent(String tableId, ConsistencyToken token) { * * @param tableId * @param token - * @return ApiFuture */ public ApiFuture isConsistentAsync(String tableId, ConsistencyToken token) { ApiFuture checkConsResp = @@ -629,7 +614,7 @@ public Boolean apply(CheckConsistencyResponse input) { * projects/{project}/instances/{instance}/tables/{tableId} * * @param tableId - * @return String - unique table name + * @return unique table name */ @VisibleForTesting String getTableName(String tableId) { @@ -638,8 +623,6 @@ String getTableName(String tableId) { /** * Helper method to build an instance of ListTablesRequest - * - * @return ListTablesRequest */ @VisibleForTesting ListTablesRequest composeListTableRequest() { @@ -650,7 +633,6 @@ ListTablesRequest composeListTableRequest() { * Helper method to build an instance of GetTableRequest * * @param tableId - * @return GetTableRequest */ @VisibleForTesting GetTableRequest composeGetTableRequest(String tableId) { @@ -661,7 +643,6 @@ GetTableRequest composeGetTableRequest(String tableId) { * Helper method to build an instance of DeleteTableRequest * * @param tableId - * @return DeleteTableRequest */ @VisibleForTesting DeleteTableRequest composeDeleteTableRequest(String tableId) { @@ -674,7 +655,6 @@ DeleteTableRequest composeDeleteTableRequest(String tableId) { * @param tableId * @param rowKeyPrefix * @param boolean dropAll - * @return DropRowRangeRequest */ @VisibleForTesting DropRowRangeRequest composeDropRowRangeRequest( @@ -693,7 +673,6 @@ DropRowRangeRequest composeDropRowRangeRequest( * Helper method to build an instance of GenerateConsistencyTokenRequest * * @param tableId - * @return GenerateConsistencyTokenRequest */ @VisibleForTesting GenerateConsistencyTokenRequest composeGenerateConsistencyTokenRequest(String tableId) { @@ -704,7 +683,6 @@ GenerateConsistencyTokenRequest composeGenerateConsistencyTokenRequest(String ta * Helper method to convert ListTablesResponse to List * * @param listTablesResponse - * @return List */ @VisibleForTesting static List convertToTableNames(ListTablesResponse listTablesResponse) { @@ -720,7 +698,6 @@ static List convertToTableNames(ListTablesResponse listTablesResponse * Helper method to transform ApiFuture to ApiFuture
* * @param future - * @return ApiFuture
*/ @VisibleForTesting static ApiFuture
transformToTableResponse( @@ -739,7 +716,6 @@ public Table apply(com.google.bigtable.admin.v2.Table table) { * Helper method to transform ApiFuture to ApiFuture * * @param future - * @return ApiFuture */ @VisibleForTesting static ApiFuture transformToVoid(ApiFuture future) { diff --git a/google-cloud-clients/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/models/GCRules.java b/google-cloud-clients/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/models/GCRules.java index 624f91781a78..1ee6263030fe 100644 --- a/google-cloud-clients/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/models/GCRules.java +++ b/google-cloud-clients/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/models/GCRules.java @@ -37,8 +37,6 @@ private GCRules() {} /** * Creates a new instance of the IntersectionRule - * - * @return IntersectionRule */ public IntersectionRule intersection() { return new IntersectionRule(); @@ -46,8 +44,6 @@ public IntersectionRule intersection() { /** * Creates a new instance of the IntersectionRule - * - * @return UnionRule */ public UnionRule union() { return new UnionRule(); @@ -57,7 +53,6 @@ public UnionRule union() { * Creates a new instance of the VersionRule * * @param maxVersion - maximum number of cell versions to keep - * @return VersionRule */ public VersionRule maxVersions(int maxVersion) { return new VersionRule(maxVersion); @@ -68,7 +63,6 @@ public VersionRule maxVersions(int maxVersion) { * * @param maxAge - maximum age of the cell to keep * @param timeUnit - timeunit for the age - * @return DurationRule */ public DurationRule maxAge(long maxAge, TimeUnit timeUnit) { return maxAge(Duration.ofNanos(TimeUnit.NANOSECONDS.convert(maxAge, timeUnit))); @@ -78,7 +72,6 @@ public DurationRule maxAge(long maxAge, TimeUnit timeUnit) { * Creates a new instance of the DurationRule * * @param duration - age expressed as duration - * @return DurationRule */ public DurationRule maxAge(Duration duration) { return new DurationRule(duration); @@ -86,8 +79,6 @@ public DurationRule maxAge(Duration duration) { /** * Creates an empty default rule - * - * @return DefaultRule */ public DefaultRule defaultRule() { return new DefaultRule(); @@ -108,7 +99,6 @@ private IntersectionRule() { * Adds a new GCRule * * @param rule - * @return IntersectionRule */ public IntersectionRule rule(@Nonnull GCRule rule) { rulesList.add(rule); @@ -117,8 +107,6 @@ public IntersectionRule rule(@Nonnull GCRule rule) { /** * Gets the list of child rules - * - * @return List */ public List getRulesList() { return rulesList; @@ -160,7 +148,6 @@ private UnionRule() { * Adds a new GCRule * * @param rule - * @return UnionRule */ public UnionRule rule(@Nonnull GCRule rule) { rulesList.add(rule); @@ -169,8 +156,6 @@ public UnionRule rule(@Nonnull GCRule rule) { /** * Gets the list of child rules - * - * @return List */ public List getRulesList() { return rulesList; @@ -236,8 +221,6 @@ private DurationRule(Duration duration) { /** * Gets the configured maximum age - * - * @return Duration */ public Duration getMaxAge() { return Duration.ofSeconds(builder.getSeconds(), builder.getNanos()); diff --git a/google-cloud-clients/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/models/TableAdminResponses.java b/google-cloud-clients/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/models/TableAdminResponses.java index 82edc5184419..42b9f22a8ecb 100644 --- a/google-cloud-clients/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/models/TableAdminResponses.java +++ b/google-cloud-clients/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/models/TableAdminResponses.java @@ -46,7 +46,7 @@ private TableAdminResponses() {} * Converts the protocol buffer table to a simpler Table model with only the required elements * * @param table - Protobuf table - * @return Table - Table response wrapper + * @return Table response wrapper */ @InternalApi public static Table convertTable(com.google.bigtable.admin.v2.Table table) { @@ -58,7 +58,7 @@ public static Table convertTable(com.google.bigtable.admin.v2.Table table) { * is. * * @param tokenResponse - Protobuf ConsistencyTokenResponse - * @return ConsistencyToken - ConsistencyToken response wrapper + * @return ConsistencyToken response wrapper */ @InternalApi public static ConsistencyToken convertTokenResponse( @@ -71,7 +71,6 @@ public static ConsistencyToken convertTokenResponse( * elements * * @param clusterStatesMap - Protobuf clusterStatesMap - * @return Map */ @InternalApi public static Map convertClusterStates( @@ -90,7 +89,6 @@ public static Map convertClusterStates( * elements * * @param columnFamiliesMap - Protobuf columnFamiliesMap - * @return Map */ @InternalApi public static Map convertColumnFamilies( @@ -120,8 +118,6 @@ private Table(com.google.bigtable.admin.v2.Table table) { /** * Gets the unique name of the table in the format: * projects/{project}/instances/{instance}/tables/{tableId} - * - * @return TableName */ public TableName getTableName() { return tableName; @@ -130,8 +126,6 @@ public TableName getTableName() { /** * Returns state of the table by clusters in the instance as map of clusterId and {@link * ClusterState} - * - * @return Map */ public Map getClusterStatesMap() { return clusterStates; @@ -139,8 +133,6 @@ public Map getClusterStatesMap() { /** * Returns a map of columfamilies in the table keyed by columnfamily and name - * - * @return Map */ public Map getColumnFamiliesMap() { return columnFamilies; @@ -148,8 +140,6 @@ public Map getColumnFamiliesMap() { /** * Returns state of the table by clusters in the instance as a Collection - * - * @return Collection */ public Collection getClusterStates() { return clusterStates.values(); @@ -157,8 +147,6 @@ public Collection getClusterStates() { /** * Returns all columnfamilies in the table as a Collection - * - * @return */ public Collection getColumnFamiles() { return columnFamilies.values(); @@ -186,8 +174,6 @@ private ClusterState(String id, com.google.bigtable.admin.v2.Table.ClusterState /** * Gets the cluster Id - * - * @return String */ public String getId() { return id; @@ -195,8 +181,6 @@ public String getId() { /** * Gets the ReplicationState of the table for this cluster - * - * @return ReplicationState */ public ReplicationState getReplicationState() { return replicationState; @@ -228,8 +212,6 @@ private ColumnFamily(String id, com.google.bigtable.admin.v2.ColumnFamily cf) { /** * Gets the columnfamily name - * - * @return String */ public String getId() { return id; @@ -237,8 +219,6 @@ public String getId() { /** * Get's the GCRule configured for the columnfamily - * - * @return GCRule */ public GCRule getGCRule() { return gCRule; @@ -246,8 +226,6 @@ public GCRule getGCRule() { /** * Returns true if a GCRule has been configured for the family - * - * @return */ public boolean hasGcRule() { return !RuleCase.RULE_NOT_SET.equals(gCRule.toProto().getRuleCase());