Skip to content

Commit aee1ac3

Browse files
mziccardmziccard
committed
Provide better javadoc to address related classes
1 parent c45336b commit aee1ac3

4 files changed

Lines changed: 26 additions & 22 deletions

File tree

‎gcloud-java-compute/src/main/java/com/google/gcloud/compute/Address.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,8 @@ public Address reload(Compute.AddressOption... options) throws ComputeException
141141
/**
142142
* Deletes this address.
143143
*
144-
* @return an operation object if delete request was successfully sent, {@code null} if the
145-
* address was not found
144+
* @return an {@code Operation} object if delete request was successfully sent, {@code null} if
145+
* the address was not found
146146
* @throws ComputeException upon failure
147147
*/
148148
public Operation delete(Compute.OperationOption... options) throws ComputeException {

‎gcloud-java-compute/src/main/java/com/google/gcloud/compute/AddressInfo.java‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,12 @@ public enum Status {
9090
}
9191

9292
/**
93-
* Base class for a Google Compute Engine address usage information. {@link InstanceUsage} is for
94-
* addresses assigned to a Google Compute Engine instance.
93+
* Base class for a Google Compute Engine address's usage information. Implementations of this
94+
* class represent different possible usages of a Compute Engine address. {@link InstanceUsage}
95+
* contains information for region addresses assigned to a Google Compute Engine instance.
96+
* {@link RegionForwardingUsage} contains information for region addresses assigned to one or more
97+
* region forwarding rule. {@link GlobalForwardingUsage} contains information for global addresses
98+
* assigned to one or more global forwarding rule.
9599
*/
96100
public abstract static class Usage implements Serializable {
97101

@@ -430,7 +434,7 @@ public String description() {
430434
}
431435

432436
/**
433-
* Returns an unique identifier for the address; defined by the service.
437+
* Returns the unique identifier for the address; defined by the service.
434438
*/
435439
public String id() {
436440
return id;
@@ -529,37 +533,37 @@ Address toPb() {
529533
}
530534

531535
/**
532-
* Returns a builder for the AddressInfo object given it's identity.
536+
* Returns a builder for the {@code AddressInfo} object given it's identity.
533537
*/
534538
public static BuilderImpl builder(AddressId addressId) {
535539
return new BuilderImpl().addressId(addressId);
536540
}
537541

538542
/**
539-
* Returns an AddressInfo object for the provided identity.
543+
* Returns an {@code AddressInfo} object for the provided identity.
540544
*/
541545
public static AddressInfo of(AddressId addressId) {
542546
return builder(addressId).build();
543547
}
544548

545549
/**
546-
* Returns an AddressInfo object for the provided name. Such an object corresponds to a global
550+
* Returns an {@code AddressInfo} object for the provided name. The object corresponds to a global
547551
* address.
548552
*/
549553
public static AddressInfo of(String name) {
550554
return of(GlobalAddressId.of(name));
551555
}
552556

553557
/**
554-
* Returns an AddressInfo object for the provided region identity and name. Such an object
558+
* Returns an {@code AddressInfo} object for the provided region identity and name. The object
555559
* corresponds to a region address.
556560
*/
557561
public static AddressInfo of(RegionId regionId, String name) {
558562
return of(RegionAddressId.of(regionId, name));
559563
}
560564

561565
/**
562-
* Returns an AddressInfo object for the provided region and address names. Such an object
566+
* Returns an {@code AddressInfo} object for the provided region and address names. The object
563567
* corresponds to a region address.
564568
*/
565569
public static AddressInfo of(String region, String name) {

‎gcloud-java-compute/src/main/java/com/google/gcloud/compute/Compute.java‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -862,7 +862,7 @@ public static DiskTypeListOption filter(DiskTypeFilter filter) {
862862
}
863863

864864
/**
865-
* Returns an option to specify the maximum number of disk types to be returned.
865+
* Returns an option to specify the maximum number of disk types returned per page.
866866
*/
867867
public static DiskTypeListOption pageSize(long pageSize) {
868868
return new DiskTypeListOption(ComputeRpc.Option.MAX_RESULTS, pageSize);
@@ -907,7 +907,7 @@ public static DiskTypeAggregatedListOption filter(DiskTypeFilter filter) {
907907
}
908908

909909
/**
910-
* Returns an option to specify the maximum number of disk types to be returned.
910+
* Returns an option to specify the maximum number of disk types returned per page.
911911
*/
912912
public static DiskTypeAggregatedListOption pageSize(long pageSize) {
913913
return new DiskTypeAggregatedListOption(ComputeRpc.Option.MAX_RESULTS, pageSize);
@@ -955,7 +955,7 @@ private MachineTypeListOption(ComputeRpc.Option option, Object value) {
955955
}
956956

957957
/**
958-
* Returns an option to specify a filter on the machine types being listed.
958+
* Returns an option to specify a filter to the machine types being listed.
959959
*/
960960
public static MachineTypeListOption filter(MachineTypeFilter filter) {
961961
return new MachineTypeListOption(ComputeRpc.Option.FILTER, filter.toPb());
@@ -1000,7 +1000,7 @@ private MachineTypeAggregatedListOption(ComputeRpc.Option option, Object value)
10001000
}
10011001

10021002
/**
1003-
* Returns an option to specify a filter on the machine types being listed.
1003+
* Returns an option to specify a filter to the machine types being listed.
10041004
*/
10051005
public static MachineTypeAggregatedListOption filter(MachineTypeFilter filter) {
10061006
return new MachineTypeAggregatedListOption(ComputeRpc.Option.FILTER, filter.toPb());
@@ -1055,7 +1055,7 @@ private RegionListOption(ComputeRpc.Option option, Object value) {
10551055
}
10561056

10571057
/**
1058-
* Returns an option to specify a filter on the regions being listed.
1058+
* Returns an option to specify a filter to the regions being listed.
10591059
*/
10601060
public static RegionListOption filter(RegionFilter filter) {
10611061
return new RegionListOption(ComputeRpc.Option.FILTER, filter.toPb());
@@ -1122,7 +1122,7 @@ private ZoneListOption(ComputeRpc.Option option, Object value) {
11221122
}
11231123

11241124
/**
1125-
* Returns an option to specify a filter on the zones being listed.
1125+
* Returns an option to specify a filter to the zones being listed.
11261126
*/
11271127
public static ZoneListOption filter(ZoneFilter filter) {
11281128
return new ZoneListOption(ComputeRpc.Option.FILTER, filter.toPb());
@@ -1211,7 +1211,7 @@ private OperationListOption(ComputeRpc.Option option, Object value) {
12111211
}
12121212

12131213
/**
1214-
* Returns an option to specify a filter on the operations being listed.
1214+
* Returns an option to specify a filter to the operations being listed.
12151215
*/
12161216
public static OperationListOption filter(OperationFilter filter) {
12171217
return new OperationListOption(ComputeRpc.Option.FILTER, filter.toPb());

‎gcloud-java-compute/src/main/java/com/google/gcloud/spi/ComputeRpc.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -270,27 +270,27 @@ public Y y() {
270270
/**
271271
* Returns the requested region address or {@code null} if not found.
272272
*
273-
* @throws ComputeException upon failure
273+
* @throws ComputeException upon failure or if region is not found
274274
*/
275275
Address getRegionAddress(String region, String address, Map<Option, ?> options);
276276

277277
/**
278278
* Creates a new region address.
279279
*
280280
* @return a region operation for region address' creation
281-
* @throws ComputeException upon failure
281+
* @throws ComputeException upon failure or if region is not found
282282
*/
283283
Operation createRegionAddress(String region, Address address, Map<Option, ?> options);
284284

285285
/**
286286
* Lists the regions addresses for the provided region.
287287
*
288-
* @throws ComputeException upon failure
288+
* @throws ComputeException upon failure or if region is not found
289289
*/
290290
Tuple<String, Iterable<Address>> listRegionAddresses(String region, Map<Option, ?> options);
291291

292292
/**
293-
* Lists all addressest.
293+
* Lists all addresses.
294294
*
295295
* @throws ComputeException upon failure
296296
*/
@@ -301,7 +301,7 @@ public Y y() {
301301
*
302302
* @return a region operation if request was issued correctly, {@code null} if the address was not
303303
* found
304-
* @throws ComputeException upon failure
304+
* @throws ComputeException upon failure or if region is not found
305305
*/
306306
Operation deleteRegionAddress(String region, String address, Map<Option, ?> options);
307307
}

0 commit comments

Comments
 (0)