commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bay...@apache.org
Subject svn commit: r795891 - in /commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate: AggregateTranslator.java CharSequenceTranslator.java CodePointTranslator.java LookupTranslator.java
Date Mon, 20 Jul 2009 16:12:36 GMT
Author: bayard
Date: Mon Jul 20 16:12:35 2009
New Revision: 795891

URL: http://svn.apache.org/viewvc?rev=795891&view=rev
Log:
Improving Javadoc

Modified:
    commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/AggregateTranslator.java
    commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/CharSequenceTranslator.java
    commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/CodePointTranslator.java
    commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/LookupTranslator.java

Modified: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/AggregateTranslator.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/AggregateTranslator.java?rev=795891&r1=795890&r2=795891&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/AggregateTranslator.java
(original)
+++ commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/AggregateTranslator.java
Mon Jul 20 16:12:35 2009
@@ -30,6 +30,8 @@
 
     /**
      * Specify the translators to be used at creation time. 
+     *
+     * @param translators CharSequenceTranslator array to aggregate
      */
     public AggregateTranslator(CharSequenceTranslator... translators) {
         this.translators = translators;

Modified: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/CharSequenceTranslator.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/CharSequenceTranslator.java?rev=795891&r1=795890&r2=795891&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/CharSequenceTranslator.java
(original)
+++ commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/CharSequenceTranslator.java
Mon Jul 20 16:12:35 2009
@@ -41,6 +41,7 @@
      * @param index int representing the current point of translation
      * @param out Writer to translate the text to
      * @return int count of codepoints consumed
+     * @throws IOException if and only if the Writer produces an IOException
      */
     public abstract int translate(CharSequence input, int index, Writer out) throws IOException;
 
@@ -106,6 +107,9 @@
     /**
      * Helper method to create a merger of this translator with another set of 
      * translators. Useful in customizing the standard functionality.
+     *
+     * @param translators CharSequenceTranslator array of translators to merge with this
one
+     * @return CharSequenceTranslator merging this translator with the others
      */
     public final CharSequenceTranslator with(CharSequenceTranslator... translators) {
         CharSequenceTranslator[] newArray = new CharSequenceTranslator[translators.length
+ 1];

Modified: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/CodePointTranslator.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/CodePointTranslator.java?rev=795891&r1=795890&r2=795891&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/CodePointTranslator.java
(original)
+++ commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/CodePointTranslator.java
Mon Jul 20 16:12:35 2009
@@ -46,6 +46,7 @@
      * @param codepoint int character input to translate
      * @param out Writer to optionally push the translated output to
      * @return boolean as to whether translation occurred or not
+     * @throws IOException if and only if the Writer produces an IOException
      */
     public abstract boolean translate(int codepoint, Writer out) throws IOException;
 

Modified: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/LookupTranslator.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/LookupTranslator.java?rev=795891&r1=795890&r2=795891&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/LookupTranslator.java
(original)
+++ commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/LookupTranslator.java
Mon Jul 20 16:12:35 2009
@@ -34,7 +34,7 @@
     /**
      * Define the lookup table to be used in translation
      *
-     * @param CharSequence[][] Lookup table of size [*][2]
+     * @param lookup CharSequence[][] table of size [*][2]
      */
     public LookupTranslator(CharSequence[][] lookup) {
         lookupMap = new HashMap<CharSequence, CharSequence>();



Mime
View raw message