How can I replace newline characters using JSP and JSTL?

Question

I have a list of bean objects passed into my JSP page, and one of them is a comment field. This field may contain newlines, and I want to replace them with semicolons using JSTL, so that the field can be displayed in a text input. I have found one solution, but it's not very elegant. I'll post below as a possibility.

Answer 1

Here is a solution I found. It doesn't seem very elegant, though:

<%@ taglib prefix="fn" uri="http://java.sun.com/jsp/jstl/functions" %>
<% pageContext.setAttribute("newLineChar", "\n"); %>

${fn:replace(item.comments, newLineChar, "; ")}

Answer 2

You should be able to do it with fn:replace.

You will need to import the tag library into your JSP with the following declaration:

<%@ taglib prefix="fn" uri="http://java.sun.com/jsp/jstl/functions" %>

Then you can use the following expression to replace occurrences of newline in ${data} with a semicolon:

${fn:replace(data, "\n", ";")}

The documentation is not great on this stuff and I have not had the opportunity to test it.

Answer 3

You could write your own JSP function to do the replacement.

This means you'd end up with something like:

<%@ taglib prefix="ns" uri="..." %>
...
${ns:replace(data)}

Where ns is a namespace prefix you define and replace is your JSP function.

These functions are pretty easy to implement (they're just a static method) although I can't seem to find a good reference for writing these at the moment.

Answer 4

You could create your own JSP function. http://java.sun.com/j2ee/1.4/docs/tutorial/doc/JSPTags6.html

This is roughly what you need to do.

Create a tag library descriptor file
/src/META-INF/sf.tld

<?xml version="1.0" encoding="UTF-8"?>
<taglib version="2.0" xmlns="http://java.sun.com/xml/ns/j2ee" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee web-jsptaglibrary_2_0.xsd">
  <tlib-version>1.0</tlib-version>
  <short-name>sf</short-name>
  <uri>http://www.stackoverflow.com&lt;/uri&gt;
  <function>
    <name>clean</name>
    <function-class>com.stackoverflow.web.tag.function.TagUtils</function-class>
    <function-signature>
      java.lang.String clean(java.lang.String)
    </function-signature>
  </function>
</taglib>

Create a Java class for the functions logic.
com.stackoverflow.web.tag.function.TagUtils

package com.stackoverflow.web.tag.function;

import javax.servlet.jsp.tagext.TagSupport;

public class TagUtils extends TagSupport {
  public static String clean(String comment) {
    return comment.replaceAll("\n", "; ");
  }
}

In your JSP you can access your function in the following way.

<%@ taglib prefix="sf" uri="http://www.stackoverflow.com"%&gt;
${sf:clean(item.comments)}

Answer 5

In the value while setting the var, press ENTER between the double quotes.

${fn:replace(data, newLineChar, ";")}

Answer 6

This solution is more elegant than your own solution which is setting the pagecontext attribute directly. You should use the <c:set> tag for this:

<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
<%@ taglib prefix="fn" uri="http://java.sun.com/jsp/jstl/functions" %>

<c:set var="newline" value="\n"/>
${fn:replace(data, newLine, "; ")}

BTW: ${fn:replace(data, "\n", ";")} does NOT work.

Answer 7

\n does not represent the newline character in an EL expression.

The solution which sets a pageContext attribute to the newline character and then uses it with JSTL's fn:replace function does work.

However, I prefer to use the Jakarta String Tab Library to solve this problem:

<%@ taglib prefix="str" uri="http://jakarta.apache.org/taglibs/string-1.1" %>
...
<str:replace var="result" replace="~n" with=";" newlineToken="~n">
Text containing newlines
</str:replace>
...

You can use whatever you want for the newlineToken; "~n" is unlikely to show up in the text I'm doing the replacement on, so it was a reasonable choice for me.

Answer 8

This does not work for me:

<c:set var="newline" value="\n"/>
${fn:replace(data, newLine, "; ")}

This does:

<% pageContext.setAttribute("newLineChar", "\n"); %> 
${fn:replace(item.comments, newLineChar, "; ")}

Answer 9

Although this is an old topic, but one has kicked this topic and no-one was able to post the right solution, so here it is:

${fn:replace(data, '\\n', ';')}

Yes, just escape the backslash.

Answer 10

For the record, I came across this post while tackling this problem:

A multi-line string in JSTL gets added as the title attribute of a textarea. Javascript then adds this as the default text of the textarea. In order to clear this text on focus the value needs to equal the title... but fails as many text-editors put \r\n instead of \n. So the follownig will get rid of the unwanted \r:

<% pageContext.setAttribute("newLineChar", "\r"); %> 
<c:set var="textAreaDefault" value="${fn:replace(textAreaDefault, newLineChar, '')}" />

Answer 11

More easily:

<str:replace var="your_Var_replaced" replace="\n" with="Your ney caracter" newlineToken="\n">${your_Var_to_replaced}</str:replace>