From: <th...@us...> - 2009-02-13 22:58:09
|
Revision: 9369 http://pcgen.svn.sourceforge.net/pcgen/?rev=9369&view=rev Author: thpr Date: 2009-02-13 22:30:22 +0000 (Fri, 13 Feb 2009) Log Message: ----------- docs cleanup items found by FindBugs Modified Paths: -------------- Trunk/pcgen/code/src/java/pcgen/base/lang/StringUtil.java Trunk/pcgen/code/src/java/pcgen/base/util/DoubleKeyMapToList.java Trunk/pcgen/code/src/java/pcgen/base/util/FixedStringList.java Trunk/pcgen/code/src/java/pcgen/base/util/TripleKeyMap.java Trunk/pcgen/code/src/java/pcgen/base/util/TripleKeyMapToList.java Trunk/pcgen/code/src/java/pcgen/base/util/WeightedCollection.java Modified: Trunk/pcgen/code/src/java/pcgen/base/lang/StringUtil.java =================================================================== --- Trunk/pcgen/code/src/java/pcgen/base/lang/StringUtil.java 2009-02-13 22:28:12 UTC (rev 9368) +++ Trunk/pcgen/code/src/java/pcgen/base/lang/StringUtil.java 2009-02-13 22:30:22 UTC (rev 9369) @@ -65,7 +65,7 @@ * @return A 'separator' separated String */ public static String join(final Collection<?> strings, - final String separator) + final String separator) { return joinToStringBuffer(strings, separator).toString(); } @@ -86,7 +86,7 @@ * @return A 'separator' separated String */ public static StringBuilder joinToStringBuffer(final Collection<?> strings, - final String separator) + final String separator) { if (strings == null) { @@ -150,13 +150,26 @@ /** * Replaces all of the instances of the find String with newStr in the * (first) given String. + * + * @param in + * The input String in which the String replacement should take + * place + * @param find + * The String to find within the input String, and which will be + * replaced by the newStr + * @param newStr + * The new String that replaces the String to find within the + * input String + * @return A new String created as a result of modifying the input String to + * replace all instances of the String to find with the newStr + * replacement String */ public static String replaceAll(final String in, final String find, - final String newStr) + final String newStr) { final char[] working = in.toCharArray(); - final StringBuilder sb = - new StringBuilder(in.length() + newStr.length()); + final StringBuilder sb = new StringBuilder(in.length() + + newStr.length()); int startindex = in.indexOf(find); if (startindex < 0) Modified: Trunk/pcgen/code/src/java/pcgen/base/util/DoubleKeyMapToList.java =================================================================== --- Trunk/pcgen/code/src/java/pcgen/base/util/DoubleKeyMapToList.java 2009-02-13 22:28:12 UTC (rev 9368) +++ Trunk/pcgen/code/src/java/pcgen/base/util/DoubleKeyMapToList.java 2009-02-13 22:30:22 UTC (rev 9369) @@ -175,11 +175,11 @@ * @param key2 * The secondary key indicating which List the given objects * should be added to. - * @param list + * @param values * A Collection containing the items to be added to the List for * the given keys. */ - public void addAllToListFor(K1 key1, K2 key2, Collection<V> value) + public void addAllToListFor(K1 key1, K2 key2, Collection<V> values) { MapToList<K2, V> localMap = mtmtl.get(key1); if (localMap == null) @@ -187,7 +187,7 @@ localMap = GenericMapToList.getMapToList(secondClass); mtmtl.put(key1, localMap); } - localMap.addAllToListFor(key2, value); + localMap.addAllToListFor(key2, values); } /** Modified: Trunk/pcgen/code/src/java/pcgen/base/util/FixedStringList.java =================================================================== --- Trunk/pcgen/code/src/java/pcgen/base/util/FixedStringList.java 2009-02-13 22:28:12 UTC (rev 9368) +++ Trunk/pcgen/code/src/java/pcgen/base/util/FixedStringList.java 2009-02-13 22:30:22 UTC (rev 9369) @@ -69,7 +69,7 @@ /** * The String array underlying the FixedStringList */ - String[] array; + private final String[] array; /** * Creates a new FixedStringList of the given size. All values in the Modified: Trunk/pcgen/code/src/java/pcgen/base/util/TripleKeyMap.java =================================================================== --- Trunk/pcgen/code/src/java/pcgen/base/util/TripleKeyMap.java 2009-02-13 22:28:12 UTC (rev 9368) +++ Trunk/pcgen/code/src/java/pcgen/base/util/TripleKeyMap.java 2009-02-13 22:30:22 UTC (rev 9369) @@ -356,9 +356,9 @@ for (K2 key2 : map.getSecondaryKeySet(key1)) { Map<K3, V> local = map.get(key1, key2); - for (K3 key3 : local.keySet()) + for (Map.Entry<K3, V> me : local.entrySet()) { - tkm.put(key1, key2, key3, local.get(key3)); + tkm.put(key1, key2, me.getKey(), me.getValue()); } } } Modified: Trunk/pcgen/code/src/java/pcgen/base/util/TripleKeyMapToList.java =================================================================== --- Trunk/pcgen/code/src/java/pcgen/base/util/TripleKeyMapToList.java 2009-02-13 22:28:12 UTC (rev 9368) +++ Trunk/pcgen/code/src/java/pcgen/base/util/TripleKeyMapToList.java 2009-02-13 22:30:22 UTC (rev 9369) @@ -282,6 +282,9 @@ * TripleKeyMapToList, and modification of this TripleKeyMapToList will not * alter the returned Set. * + * @param aPrimaryKey + * The primary key to retrieve keys for. + * * @return A Set containing the secondary keys for the given primary key * within this TripleKeyMapToList. */ Modified: Trunk/pcgen/code/src/java/pcgen/base/util/WeightedCollection.java =================================================================== --- Trunk/pcgen/code/src/java/pcgen/base/util/WeightedCollection.java 2009-02-13 22:28:12 UTC (rev 9368) +++ Trunk/pcgen/code/src/java/pcgen/base/util/WeightedCollection.java 2009-02-13 22:30:22 UTC (rev 9369) @@ -422,7 +422,7 @@ * possible to actually sort before doing the comparison. - thpr 2/5/07 */ return o instanceof WeightedCollection - && theData.equals(((WeightedCollection) o).theData); + && theData.equals(((WeightedCollection<?>) o).theData); } /** This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |