You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@shindig.apache.org by li...@apache.org on 2010/08/27 23:49:30 UTC
svn commit: r990285 - in
/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social:
core/model/GroupImpl.java opensocial/model/Group.java
opensocial/service/GroupHandler.java opensocial/spi/GroupService.java
Author: lindner
Date: Fri Aug 27 21:49:30 2010
New Revision: 990285
URL: http://svn.apache.org/viewvc?rev=990285&view=rev
Log:
spacing, docs
Modified:
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/GroupImpl.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Group.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/GroupHandler.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/GroupService.java
Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/GroupImpl.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/GroupImpl.java?rev=990285&r1=990284&r2=990285&view=diff
==============================================================================
--- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/GroupImpl.java (original)
+++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/GroupImpl.java Fri Aug 27 21:49:30 2010
@@ -21,31 +21,33 @@ package org.apache.shindig.social.core.m
import org.apache.shindig.social.opensocial.model.Group;
import org.apache.shindig.social.opensocial.spi.GroupId;
-public class GroupImpl implements Group{
-
- private GroupId groupId;
- private String title;
- private String description;
-
- public String getTitle() {
- return title;
- }
- public void setTitle(String title) {
- this.title = title;
- }
- public String getDescription() {
- return description;
- }
- public void setDescription(String description) {
- this.description = description;
- }
-
- public void setId(GroupId groupId) {
- this.groupId = groupId;
- }
- public GroupId getId() {
- return groupId;
- }
-
+public class GroupImpl implements Group {
+ private GroupId groupId;
+ private String title;
+ private String description;
+
+ public String getTitle() {
+ return title;
+ }
+
+ public void setTitle(String title) {
+ this.title = title;
+ }
+
+ public String getDescription() {
+ return description;
+ }
+
+ public void setDescription(String description) {
+ this.description = description;
+ }
+
+ public void setId(GroupId groupId) {
+ this.groupId = groupId;
+ }
+
+ public GroupId getId() {
+ return groupId;
+ }
}
Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Group.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Group.java?rev=990285&r1=990284&r2=990285&view=diff
==============================================================================
--- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Group.java (original)
+++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Group.java Fri Aug 27 21:49:30 2010
@@ -38,46 +38,78 @@ import com.google.inject.ImplementedBy;
@Exportablebean
public interface Group {
- public static enum Field {
- /** Unique ID for this group Required. */
- ID("Id"),
- /** Title of group Required. */
- TITLE("title"),
- /** Description of group Optional. */
- DESCRIPTION("description");
-
- /**
- * The json field that the instance represents.
- */
- private final String jsonString;
-
- /**
- * create a field base on the a json element.
- *
- * @param jsonString the name of the element
- */
- private Field(String jsonString) {
- this.jsonString = jsonString;
- }
-
- /**
- * emit the field as a json element.
- *
- * @return the field name
- */
- @Override
- public String toString() {
- return jsonString;
- }
- }
-
- GroupId getId();
- void setId(GroupId id);
-
- String getTitle();
- void setTitle(String title);
-
- String getDescription();
- void setDescription(String description);
-
+ public static enum Field {
+ /**
+ * Unique ID for this group Required.
+ */
+ ID("Id"),
+ /**
+ * Title of group Required.
+ */
+ TITLE("title"),
+ /**
+ * Description of group Optional.
+ */
+ DESCRIPTION("description");
+
+ /**
+ * The json field that the instance represents.
+ */
+ private final String jsonString;
+
+ /**
+ * create a field base on the a json element.
+ *
+ * @param jsonString the name of the element
+ */
+ private Field(String jsonString) {
+ this.jsonString = jsonString;
+ }
+
+ /**
+ * emit the field as a json element.
+ *
+ * @return the field name
+ */
+ @Override
+ public String toString() {
+ return jsonString;
+ }
+ }
+
+ /**
+ * @return a groupId for this group
+ */
+ GroupId getId();
+
+ /**
+ * Set the default group id
+ *
+ * @param id a valid GroupId
+ */
+ void setId(GroupId id);
+
+ /**
+ * @return the title of the group
+ */
+ String getTitle();
+
+ /**
+ * Sets the title of this group
+ *
+ * @param title a valid title
+ */
+ void setTitle(String title);
+
+ /**
+ * @return the description of this group
+ */
+ String getDescription();
+
+ /**
+ * Sets the description of this group
+ *
+ * @param description a valid description
+ */
+ void setDescription(String description);
}
Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/GroupHandler.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/GroupHandler.java?rev=990285&r1=990284&r2=990285&view=diff
==============================================================================
--- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/GroupHandler.java (original)
+++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/GroupHandler.java Fri Aug 27 21:49:30 2010
@@ -32,25 +32,25 @@ import org.apache.shindig.social.opensoc
import com.google.inject.Inject;
-@Service(name = "groups", path="/{userId}")
+@Service(name = "groups", path = "/{userId}")
public class GroupHandler {
- private final GroupService service;
+ private final GroupService service;
- @Inject
- public GroupHandler(GroupService service){
- this.service = service;
- }
-
- @Operation(httpMethods="GET")
- public Future<?> get(SocialRequestItem request) throws ProtocolException {
- Set<UserId> userIds = request.getUsers();
- CollectionOptions options = new CollectionOptions(request);
-
- // Preconditions
- HandlerPreconditions.requireNotEmpty(userIds, "No userId specified");
- HandlerPreconditions.requireSingular(userIds, "Only one userId must be specified");
+ @Inject
+ public GroupHandler(GroupService service) {
+ this.service = service;
+ }
+
+ @Operation(httpMethods = "GET")
+ public Future<?> get(SocialRequestItem request) throws ProtocolException {
+ Set<UserId> userIds = request.getUsers();
+ CollectionOptions options = new CollectionOptions(request);
+
+ // Preconditions
+ HandlerPreconditions.requireNotEmpty(userIds, "No userId specified");
+ HandlerPreconditions.requireSingular(userIds, "Only one userId must be specified");
- return service.getGroups(userIds.iterator().next(), options, request.getFields(), request.getToken());
- }
+ return service.getGroups(userIds.iterator().next(), options, request.getFields(), request.getToken());
+ }
}
Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/GroupService.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/GroupService.java?rev=990285&r1=990284&r2=990285&view=diff
==============================================================================
--- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/GroupService.java (original)
+++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/GroupService.java Fri Aug 27 21:49:30 2010
@@ -26,7 +26,13 @@ import org.apache.shindig.protocol.Restf
import org.apache.shindig.social.opensocial.model.Group;
public interface GroupService {
-
- public Future<RestfulCollection<Group>> getGroups(UserId userId, CollectionOptions options, Set<String> fields, SecurityToken token);
+ /**
+ * @param userId a userId object
+ * @param options search/sort/filtering options
+ * @param fields Field search/sort
+ * @param token a valid security token
+ * @return a collection of groups for a specific userId
+ */
+ public Future<RestfulCollection<Group>> getGroups(UserId userId, CollectionOptions options, Set<String> fields, SecurityToken token);
}