Author: cbrisson Date: Fri Nov 9 07:08:28 2007 New Revision: 593552 URL: http://svn.apache.org/viewvc?rev=593552&view=rev Log: some javadoc
Modified: velocity/tools/branches/2.x/src/main/java/org/apache/velocity/tools/generic/ValueParser.java Modified: velocity/tools/branches/2.x/src/main/java/org/apache/velocity/tools/generic/ValueParser.java URL: http://svn.apache.org/viewvc/velocity/tools/branches/2.x/src/main/java/org/apache/velocity/tools/generic/ValueParser.java?rev=593552&r1=593551&r2=593552&view=diff ============================================================================== --- velocity/tools/branches/2.x/src/main/java/org/apache/velocity/tools/generic/ValueParser.java (original) +++ velocity/tools/branches/2.x/src/main/java/org/apache/velocity/tools/generic/ValueParser.java Fri Nov 9 07:08:28 2007 @@ -31,6 +31,9 @@ * * <p>This comes in very handy when parsing parameters.</p> * + * <p>When subkeys are allowed, getValue("foo") will also search for all keys + * of the form "foo.bar" and return a map "bar" -> value for all values found.</p> + * * TODO: someone doing java configuration ought to be able to put a source Map * in the tool properties, allowing this to be used like other tools * @@ -51,6 +54,12 @@ */ private boolean hasSubkeys = true; + /** + * The key used for specifying a whether to support subkeys + */ + public static final String ALLOWSUBKEYS_KEY = "allowSubkeys"; + + public ValueParser() {} public ValueParser(Map source) @@ -374,15 +383,29 @@ return toLocales(getValues(key)); } + /** + * Are subkeys allowed ? + * @return yes/no + */ protected boolean getAllowSubkeys() { return allowSubkeys; } + /** + * allow or disallow subkeys + * @param allow + */ protected void setAllowSubkeys(boolean allow) { allowSubkeys = allow; } - protected Object getSubkey(String subkey) { + /** + * subkey getter that returns a map <subkey#2> -> value + * + * @param subkey + * @return + */ + protected Map<String,Object> getSubkey(String subkey) { if (!hasSubkeys || subkey == null || subkey.length() == 0) { return null; }