Author: ieb
Date: Mon Oct 13 15:41:08 2008
New Revision: 704279
URL: http://svn.apache.org/viewvc?rev=704279&view=rev
Log:
Fixed some formatting and javadoc errors.
Modified:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/ListField.java
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/MediaItem.java
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Message.java
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Organization.java
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Person.java
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Url.java
Modified:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/ListField.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/ListField.java?rev=704279&r1=704278&r2=704279&view=diff
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/ListField.java
(original)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/ListField.java
Mon Oct 13 15:41:08 2008
@@ -21,7 +21,6 @@
import com.google.inject.ImplementedBy;
[EMAIL PROTECTED](ListFieldImpl.class)
/**
* <p>
@@ -32,6 +31,7 @@
* Introduced in v0.8.1
* </p>
*/
[EMAIL PROTECTED](ListFieldImpl.class)
public interface ListField {
/**
@@ -59,6 +59,9 @@
this.jsonString = jsonString;
}
+ /**
+ * @return the string representation of the enum.
+ */
@Override
public String toString() {
return this.jsonString;
Modified:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/MediaItem.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/MediaItem.java?rev=704279&r1=704278&r2=704279&view=diff
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/MediaItem.java
(original)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/MediaItem.java
Mon Oct 13 15:41:08 2008
@@ -21,12 +21,15 @@
import com.google.inject.ImplementedBy;
[EMAIL PROTECTED](MediaItemImpl.class)
/**
* A container for the media item.
*/
[EMAIL PROTECTED](MediaItemImpl.class)
public interface MediaItem {
+ /**
+ * Fields for MediaItem.
+ */
public static enum Field {
/** the field name for mimeType. */
MIME_TYPE("mimeType"),
@@ -49,6 +52,9 @@
this.jsonString = jsonString;
}
+ /**
+ * @return a string representation of the enum.
+ */
@Override
public String toString() {
return this.jsonString;
@@ -80,6 +86,9 @@
this.jsonString = jsonString;
}
+ /**
+ * @return a string representation of the enum.
+ */
@Override
public String toString() {
return this.jsonString;
@@ -110,7 +119,7 @@
/**
* Get the Type of this media item, either audio, image or video.
*
- * @param the type of this media item
+ * @param type the type of this media item
*/
void setType(Type type);
Modified:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Message.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Message.java?rev=704279&r1=704278&r2=704279&view=diff
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Message.java
(original)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Message.java
Mon Oct 13 15:41:08 2008
@@ -58,6 +58,9 @@
this.jsonString = jsonString;
}
+ /**
+ * @return a string representation of the enum.
+ */
@Override
public String toString() {
return this.jsonString;
@@ -65,7 +68,7 @@
}
/**
- * The type of a message
+ * The type of a message.
*/
public enum Type {
/** An email. */
@@ -90,6 +93,9 @@
this.jsonString = jsonString;
}
+ /**
+ * @return a string representation of the enum.
+ */
@Override
public String toString() {
return this.jsonString;
@@ -129,7 +135,7 @@
Type getType();
/**
- * Sets the type of the message, as specified by opensocial.Message.Type
+ * Sets the type of the message, as specified by opensocial.Message.Type.
* @param newType the type of message (enum Message.Type)
*/
void setType(Type newType);
Modified:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Organization.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Organization.java?rev=704279&r1=704278&r2=704279&view=diff
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Organization.java
(original)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Organization.java
Mon Oct 13 15:41:08 2008
@@ -35,7 +35,7 @@
public interface Organization {
/**
- * An Enumberation of field names for Organization.
+ * An Enumeration of field names for Organization.
*/
public static enum Field {
/** the name of the address field. */
@@ -80,6 +80,9 @@
this.jsonString = jsonString;
}
+ /**
+ * @return a string representation of the enum.
+ */
@Override
public String toString() {
return this.jsonString;
Modified:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Person.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Person.java?rev=704279&r1=704278&r2=704279&view=diff
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Person.java
(original)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Person.java
Mon Oct 13 15:41:08 2008
@@ -38,22 +38,37 @@
/**
* The type of a profile url when represented as a list field.
*/
- public static final String PROFILE_URL_TYPE = "profile";
+ String PROFILE_URL_TYPE = "profile";
/**
* The type of thumbnail photo types when represented as list fields.
*/
- public static final String THUMBNAIL_PHOTO_TYPE = "thumbnail";
+ String THUMBNAIL_PHOTO_TYPE = "thumbnail";
+ /**
+ * The display name for the user.
+ * @return the display name
+ */
String getDisplayName();
+ /**
+ * Set the display name.
+ * @param displayName the new display name.
+ */
void setDisplayName(String displayName);
/**
* Enumeration of genders.
*/
public enum Gender {
- female, male
+ /**
+ * Female.
+ */
+ female,
+ /**
+ * Male.
+ */
+ male
}
/**
Modified:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Url.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Url.java?rev=704279&r1=704278&r2=704279&view=diff
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Url.java
(original)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Url.java
Mon Oct 13 15:41:08 2008
@@ -21,11 +21,11 @@
import com.google.inject.ImplementedBy;
[EMAIL PROTECTED](UrlImpl.class)
/**
* The base interface of all Url objects.
*/
[EMAIL PROTECTED](UrlImpl.class)
public interface Url extends ListField {
/**
@@ -40,7 +40,7 @@
TYPE("type");
/**
- * The name of this field
+ * The name of this field.
*/
private final String jsonString;
@@ -53,6 +53,9 @@
this.jsonString = jsonString;
}
+ /**
+ * The string representation of the enum.
+ */
@Override
public String toString() {
return this.jsonString;
