Examples of com.admc.util.Expander

com.admc.util.Expander

Expands ${references} in Strings.

Map keys are constrained to the character set [\w.] by converting characters outside of that range to underscores. The putAll methods return a map describing keys that have been renamed according to this algorithm.

References look like ${this} or ${-this} or ${!this}. If the map element ('this' in these examples) is set, these references will all expand to the same exact thing (obviously the value of the map element with key 'this'). The difference only applies if there is no map element with key 'this'. In that case, ${this} remains exactly as it was (the input Creole is not changed at all); ${-this} is removed (i.e. replace with an empty string); and ${!this} will cause the expand() method to throw.

I would much prefer to write this with Groovy, but GroovyDoc sucks and I want to provide a real API Spec for integrators to work from.

Nested definitions, like a map value containing '${ref}', are supported, but the nested values are de-referenced by the put* methods, not in the expand method. Therefore, they are dereferenced at setup time, not at expand time. Consequently, if you use putAll() call with intra-references, you must ensure that you use an order-preserving Map implementation, and that the referents' values are completely defined before the referers. Two other ways to satisfy this use-case are to use your own loop and call put*() instead of putAll(); or to move referred-to definitions into an additional map that is fed to putAll() before your main map.

The escape mechanism is \${, \$[, \$(. All that will happen is the backslash there will be removed.

@author Blaine Simpson (blaine dot simpson at admc dot com) @since 1.1.2

                    .getAbsolutePath());
            tmpDir = tmpDir.getParentFile();
        }


        JCreole jCreole = new JCreole(IOUtil.toString(bpStream));
        Expander htmlExpander = jCreole.getHtmlExpander();
        Date now = new Date();
        htmlExpander.put(
                "isoDateTime", isoDateTimeFormatter.format(now), false);
        htmlExpander.put("isoDate", isoDateFormatter.format(now), false);
        htmlExpander.put("contextPath", contextPath, false);
        htmlExpander.put("pageBaseName", pageBaseName, false);
        htmlExpander.put("pageDirPath", absUrlDirPath, false);
        htmlExpander.put("pageTitle", absUrlBasePath, false);
        if (readmeSb == null) {
            htmlExpander.put("readmeContent", "");
        } else {
            JCreole readmeJCreole = new JCreole();
            readmeJCreole.setHtmlExpander(htmlExpander);
            readmeJCreole.setInterWikiMapper(this);
            readmeJCreole.setPrivileges(jcreolePrivs);
            htmlExpander.put("readmeContent", readmeJCreole.postProcess(
                    readmeJCreole.parseCreole(readmeSb), "\n"), false);
        }
        if (fsDirFile != null) {
            FileComparator.SortBy sortBy = FileComparator.SortBy.NAME;
            boolean ascending = true;
            String sortStr = req.getParameter("sort");
            if (sortStr != null) {
                Matcher m = sortParamPattern.matcher(sortStr);
                if (!m.matches())
                    throw new ServletException(
                            "Malformatted sort value: " + sortStr);
                ascending = m.group(1).equals("+");
                try {
                    sortBy = Enum.valueOf(
                            FileComparator.SortBy.class, m.group(2));
                } catch (Exception e) {
                    throw new ServletException(
                            "Malformatted sort string: " + sortStr);
                }
            }
            htmlExpander.put("index", "\n"
                    + indexer.generateTable(fsDirFile, absUrlDirPath, true,
                    sortBy, ascending), false);
            // An alternative for using the Tomcat-like Indexer in a
            // htmlExpander would be to write a Creole table to a
            // creoleExpander.

Examples of com.admc.util.Expander

Related Classes of com.admc.util.Expander