abdera-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jmsn...@apache.org
Subject svn commit: r1239424 - in /abdera/abdera2/common/src/main/java/org/apache/abdera2/common: pusher/Pushers.java templates/Template.java
Date Thu, 02 Feb 2012 00:44:43 GMT
Author: jmsnell
Date: Thu Feb  2 00:44:43 2012
New Revision: 1239424

URL: http://svn.apache.org/viewvc?rev=1239424&view=rev
Log:
documentation updates.. make pushers final

Modified:
    abdera/abdera2/common/src/main/java/org/apache/abdera2/common/pusher/Pushers.java
    abdera/abdera2/common/src/main/java/org/apache/abdera2/common/templates/Template.java

Modified: abdera/abdera2/common/src/main/java/org/apache/abdera2/common/pusher/Pushers.java
URL: http://svn.apache.org/viewvc/abdera/abdera2/common/src/main/java/org/apache/abdera2/common/pusher/Pushers.java?rev=1239424&r1=1239423&r2=1239424&view=diff
==============================================================================
--- abdera/abdera2/common/src/main/java/org/apache/abdera2/common/pusher/Pushers.java (original)
+++ abdera/abdera2/common/src/main/java/org/apache/abdera2/common/pusher/Pushers.java Thu
Feb  2 00:44:43 2012
@@ -23,7 +23,7 @@ import com.google.common.base.Function;
 import com.google.common.base.Predicate;
 import com.google.common.util.concurrent.AbstractFuture;
 
-public class Pushers {
+public final class Pushers {
 
   public static <T>Function<T,Void> pushAsFunction(
     final Pusher<T> pusher) {

Modified: abdera/abdera2/common/src/main/java/org/apache/abdera2/common/templates/Template.java
URL: http://svn.apache.org/viewvc/abdera/abdera2/common/src/main/java/org/apache/abdera2/common/templates/Template.java?rev=1239424&r1=1239423&r2=1239424&view=diff
==============================================================================
--- abdera/abdera2/common/src/main/java/org/apache/abdera2/common/templates/Template.java
(original)
+++ abdera/abdera2/common/src/main/java/org/apache/abdera2/common/templates/Template.java
Thu Feb  2 00:44:43 2012
@@ -40,6 +40,30 @@ import com.google.common.collect.Multima
 
 import static com.google.common.base.Preconditions.*;
 
+/**
+ * A URI Template as defined by (http://datatracker.ietf.org/doc/draft-gregorio-uritemplate/)

+ * 
+ * URI Templates are special strings that can be expanded into either 
+ * URI's or IRI's given an input context. For example, 
+ * 
+ *   http://{user}.example.org{/path}{?a,b}{#c}
+ * 
+ * Given the values:
+ * 
+ *   user = john
+ *   path = [x,y,z]
+ *   a    = 1
+ *   b    = 2
+ *   c    = abc
+ *   
+ * This URI Template expands to:
+ * 
+ *   http://john.example.org/x/y/z?a=1&b=2#abc
+ * 
+ * Template objects are threadsafe and immutable once created, and can be 
+ * safely initialized as final static variables and used throughout an 
+ * application
+ */
 @SuppressWarnings("unchecked")
 public final class Template 
   implements Iterable<Expression>, 



Mime
View raw message