Skip to content

Commit

Permalink
Minor javadoc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
mziccard committed May 6, 2016
1 parent 54596c0 commit 6d3a5a3
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 14 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
* for (T value : page.values()) {
* // do something with value
* }
* page = page.nextPage().get();
* page = page.nextPageAsync().get();
* }}</pre>
*
* @param <T> the value type that the page holds
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ private static class SyncNextPageFetcher<T> implements PageImpl.NextPageFetcher<

private static final long serialVersionUID = -4124568632363525351L;

private NextPageFetcher<T> asyncPageFetcher;
private final NextPageFetcher<T> asyncPageFetcher;

private SyncNextPageFetcher(NextPageFetcher<T> asyncPageFetcher) {
this.asyncPageFetcher = asyncPageFetcher;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@
/**
* Identity for a Google PubSub subscription. {@code SubscriptionId} objects are returned by the
* {@link PubSub#listSubscriptions(String, PubSub.ListOption...)} and
* {@link PubSub#listSubscriptionsAsync(String, PubSub.ListOption...)} methods as the same topic
* can be used by subscriptions in different projects.
* {@link PubSub#listSubscriptionsAsync(String, PubSub.ListOption...)} methods as a topic may have
* subscriptions from different projects.
*/
public class SubscriptionId implements Serializable {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ public Builder toBuilder() {
* letters ({@code [A-Za-z]}), numbers ({@code [0-9]}), dashes ({@code -}), underscores
* ({@code _}), periods ({@code .}), tildes ({@code ~}), plus ({@code +}) or percent signs
* ({@code %}). It must be between 3 and 255 characters in length and cannot begin with the
* string {@code goog}
* string {@code goog}.
*/
public static SubscriptionInfo of(String topic, String name) {
return builder(topic, name).build();
Expand All @@ -307,7 +307,7 @@ public static SubscriptionInfo of(String topic, String name) {
* letters ({@code [A-Za-z]}), numbers ({@code [0-9]}), dashes ({@code -}), underscores
* ({@code _}), periods ({@code .}), tildes ({@code ~}), plus ({@code +}) or percent signs
* ({@code %}). It must be between 3 and 255 characters in length and cannot begin with the
* string {@code goog}
* string {@code goog}.
*/
public static SubscriptionInfo of(TopicId topic, String name) {
return builder(topic, name).build();
Expand All @@ -323,7 +323,7 @@ public static SubscriptionInfo of(TopicId topic, String name) {
* letters ({@code [A-Za-z]}), numbers ({@code [0-9]}), dashes ({@code -}), underscores
* ({@code _}), periods ({@code .}), tildes ({@code ~}), plus ({@code +}) or percent signs
* ({@code %}). It must be between 3 and 255 characters in length and cannot begin with the
* string {@code goog}
* string {@code goog}.
* @param endpoint a URL locating the endpoint to which messages should be pushed. For example,
* an endpoint might use {@code https://example.com/push}.
*/
Expand All @@ -341,7 +341,7 @@ public static SubscriptionInfo of(String topic, String name, String endpoint) {
* letters ({@code [A-Za-z]}), numbers ({@code [0-9]}), dashes ({@code -}), underscores
* ({@code _}), periods ({@code .}), tildes ({@code ~}), plus ({@code +}) or percent signs
* ({@code %}). It must be between 3 and 255 characters in length and cannot begin with the
* string {@code goog}
* string {@code goog}.
* @param endpoint a URL locating the endpoint to which messages should be pushed. For example,
* an endpoint might use {@code https://example.com/push}.
*/
Expand All @@ -359,7 +359,7 @@ public static SubscriptionInfo of(TopicId topic, String name, String endpoint) {
* letters ({@code [A-Za-z]}), numbers ({@code [0-9]}), dashes ({@code -}), underscores
* ({@code _}), periods ({@code .}), tildes ({@code ~}), plus ({@code +}) or percent signs
* ({@code %}). It must be between 3 and 255 characters in length and cannot begin with the
* string {@code goog}
* string {@code goog}.
*/
public static Builder builder(String topic, String name) {
return builder(TopicId.of(topic), name);
Expand All @@ -375,7 +375,7 @@ public static Builder builder(String topic, String name) {
* letters ({@code [A-Za-z]}), numbers ({@code [0-9]}), dashes ({@code -}), underscores
* ({@code _}), periods ({@code .}), tildes ({@code ~}), plus ({@code +}) or percent signs
* ({@code %}). It must be between 3 and 255 characters in length and cannot begin with the
* string {@code goog}
* string {@code goog}.
*/
public static Builder builder(TopicId topic, String name) {
return new BuilderImpl(topic, name);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

/**
* Identity for a Google PubSub topic. A {@code TopicId} object can be used to create subscriptions
* for topics, possibly residing on a different project.
* for topics that possibly reside in different projects.
*/
public final class TopicId implements Serializable {

Expand All @@ -43,7 +43,8 @@ private TopicId(String project, String topic) {
}

/**
* Returns the name of the project where the topic resides.
* Returns the name of the project where the topic resides. If {@code null} the topic is assumed
* to reside in the {@link PubSubOptions#projectId()} project.
*/
public String project() {
return project;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ public Builder toBuilder() {
* ({@code [A-Za-z]}), numbers ({@code [0-9]}), dashes ({@code -}), underscores ({@code _}),
* periods ({@code .}), tildes ({@code ~}), plus ({@code +}) or percent signs ({@code %}).
* It must be between 3 and 255 characters in length and cannot begin with the string
* {@code goog}
* {@code goog}.
*/
public static TopicInfo of(String name) {
return builder(name).build();
Expand All @@ -153,7 +153,7 @@ public static TopicInfo of(String name) {
* ({@code [A-Za-z]}), numbers ({@code [0-9]}), dashes ({@code -}), underscores ({@code _}),
* periods ({@code .}), tildes ({@code ~}), plus ({@code +}) or percent signs ({@code %}).
* It must be between 3 and 255 characters in length and cannot begin with the string
* {@code goog}
* {@code goog}.
*/
public static Builder builder(String name) {
return new BuilderImpl(name);
Expand Down

0 comments on commit 6d3a5a3

Please sign in to comment.