Author: ieb
Date: Wed Nov 19 10:56:08 2008
New Revision: 719026
URL: http://svn.apache.org/viewvc?rev=719026&view=rev
Log:
A small bit cleanup on formatting and documentation.
Modified:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomAttribute.java
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomAttributeConverter.java
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomContent.java
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomLink.java
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomLinkConverter.java
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/xstream/StackWriterWrapper.java
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/xstream/WriterStack.java
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/xstream/XStream081Configuration.java
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/xstream/XStreamConfiguration.java
incubator/shindig/trunk/java/social-api/src/test/java/org/apache/shindig/social/opensocial/util/BeanXStreamAtomConverterTest.java
Modified:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomAttribute.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomAttribute.java?rev=719026&r1=719025&r2=719026&view=diff
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomAttribute.java
(original)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomAttribute.java
Wed Nov 19 10:56:08 2008
@@ -33,7 +33,7 @@
/**
* [EMAIL PROTECTED]
- *
+ *
* @see java.lang.Object#toString()
*/
@Override
Modified:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomAttributeConverter.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomAttributeConverter.java?rev=719026&r1=719025&r2=719026&view=diff
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomAttributeConverter.java
(original)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomAttributeConverter.java
Wed Nov 19 10:56:08 2008
@@ -17,12 +17,7 @@
*/
package org.apache.shindig.social.core.util.atom;
-import com.thoughtworks.xstream.converters.Converter;
-import com.thoughtworks.xstream.converters.MarshallingContext;
import com.thoughtworks.xstream.converters.SingleValueConverter;
-import com.thoughtworks.xstream.converters.UnmarshallingContext;
-import com.thoughtworks.xstream.io.HierarchicalStreamReader;
-import com.thoughtworks.xstream.io.HierarchicalStreamWriter;
/**
* Serializes attributes correctly.
Modified:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomContent.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomContent.java?rev=719026&r1=719025&r2=719026&view=diff
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomContent.java
(original)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomContent.java
Wed Nov 19 10:56:08 2008
@@ -26,7 +26,7 @@
import java.util.Map.Entry;
/**
- * Represents and atom:content element
+ * Represents and atom:content element.
*/
public class AtomContent {
Modified:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomLink.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomLink.java?rev=719026&r1=719025&r2=719026&view=diff
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomLink.java
(original)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomLink.java
Wed Nov 19 10:56:08 2008
@@ -18,7 +18,7 @@
package org.apache.shindig.social.core.util.atom;
/**
- * represents an atom:link element
+ * represents an atom:link element.
*/
public class AtomLink {
@@ -35,12 +35,12 @@
}
/**
- * @return
+ * @return the link href
*/
public String getHref() {
return href;
}
-
+
/**
* @return the rel
*/
Modified:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomLinkConverter.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomLinkConverter.java?rev=719026&r1=719025&r2=719026&view=diff
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomLinkConverter.java
(original)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/atom/AtomLinkConverter.java
Wed Nov 19 10:56:08 2008
@@ -30,7 +30,7 @@
/**
* [EMAIL PROTECTED]
- *
+ *
* @see
com.thoughtworks.xstream.converters.Converter#marshal(java.lang.Object,
* com.thoughtworks.xstream.io.HierarchicalStreamWriter,
* com.thoughtworks.xstream.converters.MarshallingContext)
@@ -48,7 +48,7 @@
/**
* [EMAIL PROTECTED]
- *
+ *
* @see
com.thoughtworks.xstream.converters.Converter#unmarshal(com.thoughtworks.xstream.io.HierarchicalStreamReader,
* com.thoughtworks.xstream.converters.UnmarshallingContext)
*/
@@ -62,7 +62,7 @@
/**
* [EMAIL PROTECTED]
- *
+ *
* @see
com.thoughtworks.xstream.converters.ConverterMatcher#canConvert(java.lang.Class)
*/
public boolean canConvert(Class clazz) {
Modified:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/xstream/StackWriterWrapper.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/xstream/StackWriterWrapper.java?rev=719026&r1=719025&r2=719026&view=diff
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/xstream/StackWriterWrapper.java
(original)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/xstream/StackWriterWrapper.java
Wed Nov 19 10:56:08 2008
@@ -39,7 +39,7 @@
* Create a [EMAIL PROTECTED] StackWriterWrapper} that wraps a
* [EMAIL PROTECTED] HierarchicalStreamWriter} and tracks where that writer
is in the
* hierarchy.
- *
+ *
* @param wrapped
* the underlying writer
* @param writerStack
@@ -57,7 +57,7 @@
* Set attribute values on the current node, but filter out class attributes
* from the writer, this is not strictly a feature of this class, but is
* required (for shindig to meet the XSD requirements.
- *
+ *
* @param name
* the name of attribute
* @param value
@@ -73,10 +73,10 @@
/**
* Begin a new element or node of the supplied name.
- *
+ *
* @param name
* the name of the node.
- *
+ *
* @see com.thoughtworks.xstream.io.WriterWrapper#startNode(java.lang.String
)
*/
@Override
@@ -132,8 +132,6 @@
super.addAttribute(e.getKey(), e.getValue());
}
currentNamespace = namespaceSet;
- } else {
-
}
writerStack.push(name, currentNamespace);
}
@@ -148,6 +146,4 @@
writerStack.pop();
super.endNode();
}
-
-
}
Modified:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/xstream/WriterStack.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/xstream/WriterStack.java?rev=719026&r1=719025&r2=719026&view=diff
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/xstream/WriterStack.java
(original)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/xstream/WriterStack.java
Wed Nov 19 10:56:08 2008
@@ -25,7 +25,7 @@
/**
* Peek into the current location of the writer.
- *
+ *
* @return the name of the current node.
*/
String peek();
@@ -43,7 +43,7 @@
/**
* add a node name into the stack indicating that the writer has moved into a
* new child element.
- *
+ *
* @param name
* the name of the new child element.
* @param namespace
@@ -60,7 +60,7 @@
String pop();
/**
- * @return
+ * @return the size of the statck
*/
int size();
Modified:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/xstream/XStream081Configuration.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/xstream/XStream081Configuration.java?rev=719026&r1=719025&r2=719026&view=diff
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/xstream/XStream081Configuration.java
(original)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/xstream/XStream081Configuration.java
Wed Nov 19 10:56:08 2008
@@ -314,16 +314,19 @@
// defaultFieldAliasMappingList.add(new
// InterfaceFieldAliasMapping("address",
// ListField.class,"value","profileVideo"));
-
+
fieldAliasMappingList.put(ConverterSet.DEFAULT,
defaultFieldAliasMappingList);
}
+ /**
+ * The Guice injector, used for creating new instances of the model.
+ */
private Injector injector;
/**
- *
+ *
*/
@Inject
public XStream081Configuration(Injector injector) {
@@ -397,9 +400,9 @@
/**
* [EMAIL PROTECTED]
- *
+ *
* @param writerStack
- *
+ *
* @see
org.apache.shindig.social.core.util.xstream.XStreamConfiguration#getXStream(org.apache.shindig.social.core.util.xstream.XStreamConfiguration.ConverterSet,
* com.thoughtworks.xstream.converters.reflection.ReflectionProvider,
* com.thoughtworks.xstream.mapper.Mapper,
@@ -414,10 +417,7 @@
getElementMappingList(c), getListElementMappingList(c),
getItemFieldMappings(c), getOmitMap(c), getElementClassMap(c));
AttributeMapper amapper = new AttributeMapper(fmapper);
-
-
-
XStream xstream = new XStream(rp, amapper, driver);
amapper.addAttributeFor(AtomAttribute.class);
for (Converter converter : getConverters(fmapper, c)) {
Modified:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/xstream/XStreamConfiguration.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/xstream/XStreamConfiguration.java?rev=719026&r1=719025&r2=719026&view=diff
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/xstream/XStreamConfiguration.java
(original)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/xstream/XStreamConfiguration.java
Wed Nov 19 10:56:08 2008
@@ -33,10 +33,9 @@
@ImplementedBy(XStream081Configuration.class)
public interface XStreamConfiguration {
public static enum ConverterSet {
- MAP(), COLLECTION(), DEFAULT();
+ MAP(), COLLECTION(), DEFAULT();
};
-
public class ConverterConfig {
public InterfaceClassMapper mapper;
public XStream xstream;
@@ -47,23 +46,26 @@
}
}
-
-
/**
+ * Generate the converter config.
+ *
* @param c
+ * which converter set.
* @param rp
+ * an XStream reflection provider.
* @param dmapper
+ * the XStream mapper.
* @param driver
+ * the XStream driver
* @param writerStack
- * @return
+ * a hirachical stack recorder.
+ * @return the converter config, used for serialization.
*/
ConverterConfig getConverterConfig(ConverterSet c, ReflectionProvider rp,
Mapper dmapper, HierarchicalStreamDriver driver, WriterStack
writerStack);
-
-
/**
- * @return
+ * @return get the namespace mappings used by the driver.
*/
Map<String, NamespaceSet> getNameSpaces();
Modified:
incubator/shindig/trunk/java/social-api/src/test/java/org/apache/shindig/social/opensocial/util/BeanXStreamAtomConverterTest.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/test/java/org/apache/shindig/social/opensocial/util/BeanXStreamAtomConverterTest.java?rev=719026&r1=719025&r2=719026&view=diff
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/test/java/org/apache/shindig/social/opensocial/util/BeanXStreamAtomConverterTest.java
(original)
+++
incubator/shindig/trunk/java/social-api/src/test/java/org/apache/shindig/social/opensocial/util/BeanXStreamAtomConverterTest.java
Wed Nov 19 10:56:08 2008
@@ -17,6 +17,13 @@
*/
package org.apache.shindig.social.opensocial.util;
+import com.google.common.collect.Lists;
+import com.google.common.collect.Maps;
+import com.google.inject.Guice;
+import com.google.inject.Injector;
+
+import junit.framework.TestCase;
+
import org.apache.shindig.common.xml.XmlException;
import org.apache.shindig.common.xml.XmlUtil;
import org.apache.shindig.social.SocialApiTestsGuiceModule;
@@ -27,32 +34,17 @@
import org.apache.shindig.social.core.model.NameImpl;
import org.apache.shindig.social.core.model.PersonImpl;
import org.apache.shindig.social.core.util.BeanXStreamAtomConverter;
-import org.apache.shindig.social.core.util.BeanXStreamConverter;
-import org.apache.shindig.social.core.util.xstream.GuiceBeanProvider;
import org.apache.shindig.social.core.util.xstream.XStream081Configuration;
import org.apache.shindig.social.opensocial.model.Activity;
import org.apache.shindig.social.opensocial.model.Address;
import org.apache.shindig.social.opensocial.model.ListField;
import org.apache.shindig.social.opensocial.model.MediaItem;
import org.apache.shindig.social.opensocial.model.Person;
-import org.apache.shindig.social.opensocial.spi.DataCollection;
-
-import com.google.common.collect.Lists;
-import com.google.common.collect.Maps;
-import com.google.inject.Guice;
-import com.google.inject.Injector;
import org.apache.commons.lang.StringUtils;
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
-import junit.framework.TestCase;
-
-import java.io.BufferedReader;
-import java.io.IOException;
-import java.io.InputStreamReader;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
@@ -157,8 +149,12 @@
XmlUtil.parse(xml);
String expectedXml = " <feed
xmlns=\"http://ns.opensocial.org/2008/opensocial\";
xmlos:osearch=\"http://a9.com/-/spec/opensearch/1.1\"; > "
- + " <entry><id>item1</id><content type=\"application/xml\"
><entry><key>value</key><value>1</value></entry></content></entry> "
- + " <entry><id>item2</id><content type=\"application/xml\"
><entry><key>value</key><value>2</value></entry></content></entry> "
+ + " <entry><id>item1</id>"
+ + " <content type=\"application/xml\"
><entry><key>value</key><value>1</value></entry></content>"
+ + " </entry> "
+ + " <entry><id>item2</id>"
+ + " <content type=\"application/xml\"
><entry><key>value</key><value>2</value></entry></content>"
+ + " </entry> "
+ " <osearch:startIndex>0</osearch:startIndex> "
+ " <osearch:totalResults>2</osearch:totalResults> "
+ " <osearch:itemsPerPage>2</osearch:itemsPerPage></feed> ";
@@ -174,8 +170,12 @@
XmlUtil.parse(xml);
String expectedXml = "<feed
xmlns=\"http://ns.opensocial.org/2008/opensocial\"; "
+ " xmlos:osearch=\"http://a9.com/-/spec/opensearch/1.1\";>"
- + " <entry><id>key1</id><content type=\"application/xml\"
><value>value1</value></content></entry>"
- + " <entry><id>key2</id><content type=\"application/xml\"
><value>value2</value></content></entry>"
+ + " <entry><id>key1</id><content type=\"application/xml\" >"
+ + " <value>value1</value></content>"
+ + " </entry>"
+ + " <entry><id>key2</id>"
+ + " <content type=\"application/xml\"
><value>value2</value></content>"
+ + " </entry>"
+ " <osearch:startIndex>0</osearch:startIndex>"
+ " <osearch:totalResults>2</osearch:totalResults>"
+ " <osearch:itemsPerPage>2</osearch:itemsPerPage></feed>";
