Jakarta Standard Tag Library

select

Specification: Jakarta Standard Tag Library

Version: 2.0

Status: Final

Release: October 19, 2020
Copyright (c) 2018, 2020 Eclipse Foundation.
jstl-dev@eclipse.org
<c:set var="varName" [scope="{page|request|session|application}"] value="value"/>
<c:forEach var="customer" items="${customers}">
    Current customer is <c:out value="${customer}"/>
</c:forEach>
<web-app>
...
    <context-param>
        <param-name>jakarta.servlet.jsp.jstl.fmt.localizationContext</param-name>
        <param-value>com.acme.MyResources</param-value>
    </context-param>
...
</web-app>
<fmt:formatDate var="formattedDate" value="${reservationDate}"/>
Date: <c:out value="${formattedDate}" default="not specified"/>
<c:if test="${book.price <= user.preferences.spendingLimit}">
    The book ${book.title} fits your budget!
</c:if>
<c:forEach var="product" items="${products}">
    <c:out value="Price of ${product.name} is ${product.price}"/>
</c:forEach>
<c:forEach var="aParam"items="${paramValues}">
    param: ${aParam.key}
    values:
    <c:forEach var="aValue" items="${aParam.value}">
        ${aValue}
    </c:forEach>
    <br>
</c:forEach>
Dear ${user.firstName}
from ${user.address.city},
thanks for visiting our website!
<%-- "productDir" is a Map object containing the description of
products, "preferences" is a Map object containing the preferences of a user --%>
product:
${productDir[product.custId]}
shipping preference:
${user.preferences["shipping"]}
<c:if test="${empty param.name}">
    Please specify your name.
</c:if>
<c:forEach begin="${requestScope.beginValue}"
           end="${requestScope.endValue}">
    ...
</c:forEach>
<c:forEach items="${products}" begin="${param.start + 10}">
    ...
</c:forEach>
City: <c:out value="${user.address.city}" default="N/A"/>
<c:forEach items="${products}" begin="${param.start + 10}">
    ...
</c:forEach>
You have <c:out value="${sessionScope.user.itemCount}"/> items.
<c:out value="${customer.address.city}" default="unknown"/>
<c:set var="foo" value="value"/>
<acme:atag>

 <acme:att1>

 <acme:foo>mumbojumbo</acme:foo>

 </acme:att1>

</acme:atag>
<c:set var="att1">

 <acme:foo>mumbojumbo</acme:foo>

</c:set>

<acme:atag att1="${att1}"/>
<!-- set property in JavaBeans object -->
<c:set target="${cust.address}" property="city" value="${city}"/>

<c:set target="${preferences}" property="color" value="${param.color}"/>

<c:set var="d" value="#{handler.everythingDisabled}"/>
...

<h:inputText id="i1" disabled="#\{d}"/>
<h:inputText id="i2" disabled="#\{d}"/>
<c:remove var="cachedResult" scope="application"/>
<c:catch var="exception">
<!-- Execution we can recover from if exception occurs -->
...
</c:catch>
<c:if test="${exception != null}">
Sorry. Processing could not be performed because...
</c:if>
<c:out value="value" [escapeXml="{true|false}"]
    [default="defaultValue"] />
<c:out value="value" [escapeXml="{true|false}"]>
    default value
</c:out>
<c:set value="value"
    var="varName" [scope="{page|request|session|application}"]/>
<c:set var="varName" [scope="{page|request|session|application}"]>
    body content
</c:set>
<c:set value="value"
    target="target" property="propertyName"/>
<c:set target="target" property="propertyName">
    body content
</c:set>
<c:set var="varName" value="deferred-value"/>
<c:remove var="varName"
          [scope="{page|request|session|application}"]/>
<c:catch [var="varName"]>
    nested actions
</c:catch>
<c:if test="${user.visitCount == 1}">
    This is your first visit. Welcome to the site!
</c:if>
<c:choose>
    <c:when test="${user.category == 'trial'}">
        ...
    </c:when>
    <c:when test="${user.category == 'member'}">
        ...
    </c:when>
    <c:when test="${user.category == 'vip'}">
        ...
    </c:when>
    <c:otherwise>
        ...
    </c:otherwise>
</c:choose>
<c:choose>
    <c:when test="${count == 0}">
        No records matched your selection.
    </c:when>
    <c:otherwise>
        ${count} records matched your selection.
    </c:otherwise>
</c:choose>
<acme:fullMoon var="isFullMoon"/>
<c:choose>
    <c:when test="${isFullMoon}">
        ...
    </c:when>
    <c:otherwise>
        ...
    </c:otherwise>
</c:choose>
<c:if test="testCondition"
    var="varName" [scope="{page|request|session|application}"]/>
<c:if test="testCondition"
        [var="varName"] [scope="{page|request|session|application}"]>
    body content
</c:if>
<c:choose>
    body content (<when> and <otherwise> subtags)
</c:choose>
<c:when test="testCondition">
    body content
</c:when>
<c:otherwise>
    conditional block
</c:otherwise>
<table>
    <c:forEach var="customer" items="${customers}">
        <tr><td>${customer}</td></tr>
    </c:forEach>
</table>
<c:forEach var="entry" items="${myHashtable}">
    Next element is ${entry.value}/>
</c:forEach>
<table>
    <c:forEach var="product" items="${products}"
            varStatus="status">
        <tr>
            <td>${status.count}</td>
            <td>${product.name}</td>
        </tr>
    </c:forEach>
</table>
<c:forEach var="i" begin="100" end="110">
    ${i}
</c:forEach>
<c:forEach var="product" items="${products}" varStatus="status">
    <c:choose>
        <c:when test="${status.count % 2 == 0}">
            even item
        </c:when>
        <c:otherwise>
            odd item
        </c:otherwise>
    </c:choose>
</c:forEach>
<c:forEach var="product" items="${products}">
    <acme:even>
        even item
    </acme:even>
    <acme:odd>
        odd item
    </acme:odd>
</c:forEach>
<c:forEach var="child" items="#{customer.children}">
    <h:inputText value="#{child.name}"/>
</c:forEach>
<c:forEach  [var="varName"] items="collection"
            [varStatus="varStatusName"]
            [begin="begin"] [end="end"] [step="step"]>
    body content
</c:forEach>
<c:forEach  [var="varName"]
            [varStatus="varStatusName"]
            begin="begin" end="end" [step="step"]>
    body content
</c:forEach>
doStartTag() +
    ...
    // 'items' is a deferred-value +
    // Get the current Expression Language VariableMapper
    VariableMapper vm =
        jspContext.getELContext().getVariableMapper();
    // Create an expression to be assigned to the variable
    // specified in the 'var' attribute.
    // 'index' is an iteration counter kept by the tag handler.
    myimpl.IndexedExpression expr =
        new myimpl.IndexExpression(getItems(), index);
    // Assign the expression to the variable specified in
    // the 'var' attribute, so any reference to that variable
    // will be replaced by the expression in subsequent
    // Expression Language evaluations.
    oldMapping = vm.setVariable(getVar(), expr);
    ...

doEndTag()
    ...
    // restore the original state of the VariableMapper
    jspContext.getELContext().getVariableMapper().setVariable(
        getVar(), oldMapping);
    ...
<c:forTokens items="stringOfTokens" delims="delimiters"
        [var="varName"]
        [varStatus="varStatusName"]
        [begin="begin"] [end="end"] [step="step"]>
    body content
</c:forTokens>
<a href="/register.jsp">Register</a>
http://acme.com/app/choose?country=Dominican+Republic
<c:url value="http://acme.com/exec/register" var="myUrl">
    <c:param name="name" value="${param.name}"/>
    <c:param name="country" value="${param.country}"/>
</c:url>
<a href='<c:out value="${myUrl}"/>'>Register</a>
<c:url value="/ads/logo.html"/>
<c:import url="ftp://ftp.acme.com/README"/>
<acme:transform>
    <jsp:include page="/exec/employeesList"/>
</acme:transform>
<%-- import a resource with an absolute URL --%>
<c:import url="http://acme.com/exec/customers?country=Japan"/>

<%-- import a resource with a relative URL - same context --%>
<c:import url="/copyright.html"/>

<%-- import a resource with a relative URL - foreign context --%>
<c:import url="/logo.html" context="/master"/>
<%-- Export the content of the URL resource as a String --%>
<c:import url="http://acme.com/exec/customers?country=USA"
          var="customers"/>
<acme:notify in="${customers}"/>

<%-- Export the content of the URL resource as a Reader --%>

<c:import url="http://acme.com/exec/customers?country=USA"
          varReader="customers">
    <acme:notify in="${customers}"/>
</c:import>
<c:redirect url="http://acme.com/register"/>
<c:import url="url" [context="context"]
        [var="varName"] [scope="{page|request|session|application}"]
        [charEncoding="charEncoding"]>
    optional body content for <c:param> subtags
</c:import>
<c:import url="url" [context="context"]
        varReader="varReaderName"
        [charEncoding="charEncoding"]>
    body content where varReader is consumed by another action
</c:import>
<c:url value="value" [context="context"]
        [var="varName"] [scope="{page|request|session|application}"]/>
<c:url value="value" [context="context"]
        [var="varName"] [scope="{page|request|session|application}"]>
    <c:param> subtags
</c:url>
<c:redirect url="value" [context="context"]/>
<c:redirect url="value" [context="context"]>
    <c:param> subtags
</c:redirect>
<c:param name="name" value="value"/>
<c:param name="name">
    parameter value
</c:param>
<c:import url="/exec/doIt">
    <c:param name="action" value="register"/>
</c:import>
<c:import url="/exec/doIt?action=register"/>
<fmt:message key="greeting"/>
<fmt:message key="athletesRegistered">
    <fmt:param>
        <fmt:formatNumber value="${athletesCount}"/>
    </fmt:param>
</fmt:message>
 french: Il y a 10 582 athletes enregistres.
english: There are 10,582 athletes registered.
<%-- Use configuration setting --%>
<fmt:message key="Welcome" />

<fmt:setBundle basename="Errors" var="errorBundle" />
<fmt:bundle basename="Greetings">
    <%-- Localization context established by
         parent <fmt:bundle> tag --%>
    <fmt:message key="Welcome" />
    <%-- Localization context established by attribute bundle --%>
    <fmt:message key="WrongPassword" bundle="${errorBundle}" />
</fmt:bundle>
<fmt:setLocale value="en_US" />
getBundle(String basename, java.util.Locale locale)
<fmt:setLocale value="locale"
            [variant="variant"]
            [scope="{page|request|session|application}"]/>
<fmt:bundle basename="basename"
            [prefix="prefix"]>
    body content
</fmt:bundle>
<fmt:bundle basename="Labels">
    <fmt:message key="com.acme.labels.firstName"/>
    <fmt:message key="com.acme.labels.lastName"/>
</fmt:bundle>
<fmt:bundle basename="Labels" prefix="com.acme.labels.">
    <fmt:message key="firstName"/>
    <fmt:message key="lastName"/>
</fmt:bundle>
<fmt:setBundle basename="basename"
               [var="varName"]
               [scope="{page|request|session|application}"]/>
<fmt:message key="messageKey"
             [bundle="resourceBundle"]
             [var="varName"]
             [scope="{page|request|session|application}"]/>
<fmt:message key="messageKey"
             [bundle="resourceBundle"]
             [var="varName"]
             [scope="{page|request|session|application}"]>
    <fmt:param> subtags
</fmt:message>
<fmt:message [bundle="resourceBundle"]
             [var="varName"]
             [scope="{page|request|session|application}"]>
    key
    optional <fmt:param> subtags
</fmt:message>
<fmt:param value="messageParameter"/>
<fmt:param>
    body content
</fmt:param>
<fmt:requestEncoding [value="charsetName"]/>
<fmt:formatNumber value="9876543.21" type="currency"/>
<fmt:formatNumber value="12.3" pattern=".000"/>
<fmt:formatNumber value="123456.7891" pattern="#,#00.0#"/>
<fmt:formatNumber value="123456789" type="currency" var="cur"/>
<fmt:parseNumber value="${cur}" type="currency"/>
<jsp:useBean id="now" class="java.util.Date"/>
<fmt:formatDate value="${now}" timeStyle="long" dateStyle="long"/>
<fmt:formatDate value="${now}" pattern="dd.MM.yy"/>_
<fmt:timeZone value="GMT+1:00">
    <fmt:formatDate value="${now}" type="both" dateStyle="full"
        timeStyle="full"/>
</fmt:timeZone>
<jsp:useBean id="now" class="java.util.Date"/>

<%-- Formatting locale lookup --%>
<fmt:formatDate value="${now}" />

<fmt:bundle basename="Greetings">
    <%-- I18n localization context from parent <fmt:bundle> tag --%>
    <fmt:message key="Welcome" />
    <fmt:formatDate value="${now}" />
</fmt:bundle>
<fmt:timeZone value="timeZone">
    body content
</fmt:timeZone>
<fmt:setTimeZone value="timeZone"
                 [var="varName"]
                 [scope="{page|request|session|application}"]/>
<fmt:formatNumber value="numericValue"
                  [type="{number|currency|percent}"]
                  [pattern="customPattern"]
                  [currencyCode="currencyCode"]
                  [currencySymbol="currencySymbol"]
                  [groupingUsed="{true|false}"]
                  [maxIntegerDigits="maxIntegerDigits"]
                  [minIntegerDigits="minIntegerDigits"]
                  [maxFractionDigits="maxFractionDigits"]
                  [minFractionDigits="minFractionDigits"]
                  [var="varName"]
                  [scope="{page|request|session|application}"]/>
<fmt:formatNumber [type="{number|currency|percent}"]
                  [pattern="customPattern"]
                  [currencyCode="currencyCode"]
                  [currencySymbol="currencySymbol"]
                  [groupingUsed="{true|false}"]
                  [maxIntegerDigits="maxIntegerDigits"]
                  [minIntegerDigits="minIntegerDigits"]
                  [maxFractionDigits="maxFractionDigits"]
                  [minFractionDigits="minFractionDigits"]
                  [var="varName"]
                  [scope="{page|request|session|application}"]>
    numeric value to be formatted
</fmt:formatNumber>
<fmt:parseNumber value="numericValue"
                [type="{number|currency|percent}"]
                [pattern="customPattern"]
                [parseLocale="parseLocale"]
                [integerOnly="{true|false}"]
                [var="varName"]
                [scope="{page|request|session|application}"]/>
<fmt:parseNumber [type="{number|currency|percent}"]
                [pattern="customPattern"]
                [parseLocale="parseLocale"]
                [integerOnly="{true|false}"]
                [var="varName"]
                [scope="{page|request|session|application}"]>
    numeric value to be parsed
</fmt:parseNumber>
<fmt:formatDate value="date"
                [type="{time|date|both}"]
                [dateStyle="{default|short|medium|long|full}"]
                [timeStyle="{default|short|medium|long|full}"]
                [pattern="customPattern"]
                [timeZone="timeZone"]
                [var="varName"]
                [scope="{page|request|session|application}"]/>
<jsp:useBean id="now" class="java.util.Date"/>
<fmt:formatDate value="${now}" />
<fmt:parseDate value="4/13/02" pattern="M/d/yy" var="parsed"/> +
<fmt:formatDate value="${parsed}" dateStyle="full"/>
<fmt:parseDate value="dateString"
            [type="{time|date|both}"]
            [dateStyle="{default|short|medium|long|full}"]
            [timeStyle="{default|short|medium|long|full}"]
            [pattern="customPattern"]
            [timeZone="timeZone"]
            [parseLocale="parseLocale"]
            [var="varName"]
            [scope="{page|request|session|application}"]/>
<fmt:parseDate [type="{time|date|both}"]
            [dateStyle="{default|short|medium|long|full}"]
            [timeStyle="{default|short|medium|long|full}"]
            [pattern="customPattern"]
            [timeZone="timeZone"]
            [parseLocale="parseLocale"]
            [var="varName"]
            [scope="{page|request|session|application}"]>
    date value to be parsed
</fmt:parseDate>
<sql:query var="customers" dataSource="${dataSource}">
    SELECT * FROM customers
    WHERE country = 'China'
    ORDER BY lastname
</sql:query>

<table>
    <c:forEach var="row" items="${customers.rows}">
        <tr>
            <td><c:out value="${row.lastName}"/></td>
            <td><c:out value="${row.firstName}"/></td>
            <td><c:out value="${row.address}"/></td>
        </tr>
    </c:forEach>
</table>
<table>
    <!-- column headers -->
    <tr>
        <c:forEach var="columnName" items="${result.columnNames}">
            <th><c:out value="${columnName}"/></th>
        </c:forEach>
    </tr>
    <!-- column data -->
    <c:forEach var="row" items="${result.rowsByIndex}">
        <tr>
            <c:forEach var="column" items="${row}">
                <td><c:out value="${column}"/></td>
            </c:forEach>
        </tr>
    </c:forEach>
</table>
<sql:transaction dataSource="${dataSource}">
    <sql:update>
        UPDATE account
        SET Balance = Balance - ?
        WHERE accountNo = ?
        <sql:param value="${transferAmount}"/>
        <sql:param value="${accountFrom}"/>
    </sql:update>
    <sql:update>
        UPDATE account
        SET Balance = Balance + ?
        WHERE accountNo = ?
        <sql:param value="${transferAmount}"/>
        <sql:param value="${accountTo}"/>
    </sql:update>
</sql:transaction>
<sql:update>
    UPDATE PersonalInfo
    SET BirthDate = ?
    WHERE clientId = ?
    <acme:dateParam year="${year}" month="${month}" day="${day}"/>
    <sql:param value="${clientId}"/>
</sql:update>
<sql:update sql="${sqlUpdateStmt}" dataSource="${dataSource}">
    <fmt:parseDate var="myDate" value="${someDate}"/>
    <sql:param value="${myDate}"/>
</sql:update>
<sql:query sql="sqlQuery"
        var="varName" [scope="{page|request|session|application}"]
        [dataSource="dataSource"]
        [maxRows="maxRows"]
        [startRow="startRow"]/>
<sql:query sql="sqlQuery"
        var="varName" [scope="{page|request|session|application}"]
        [dataSource="dataSource"]
        [maxRows="maxRows"]
        [startRow="startRow"]>
    <sql:param> actions
</sql:query>
<sql:query var="varName"
        [scope="{page|request|session|application}"]
        [dataSource="dataSource"]
        [maxRows="maxRows"]
        [startRow="startRow"]>
    query
    optional <sql:param> actions
</sql:query>
<sql:update sql="sqlUpdate"
        [dataSource="dataSource"]
        [var="varName"]
        [scope="{page|request|session|application}"]/>
<sql:update sql="sqlUpdate"
        [dataSource="dataSource"]
        [var="varName"]
        [scope="{page|request|session|application}"]>
    <sql:param> actions
</sql:update>
<sql:update [dataSource="dataSource"]
        [var="varName"] [scope="{page|request|session|application}"]>
    update statement
    optional <sql:param> actions
</sql:update>
<sql:transaction [dataSource="dataSource"]
        [isolation=isolationLevel]>
    <sql:query> and <sql:update> statements
</sql:transaction>

isolationLevel ::= "read_committed"
                | "read_uncommitted"
                | "repeatable_read"
                | "serializable"
<sql:setDataSource
        {dataSource="dataSource" |
            url="jdbcUrl"
            [driver="driverClassName"]
            [user="userName"]
            [password="password"]}
        [var="varName"]
        [scope="{page|request|session|application}"]/>
<sql:param value="value"/>
<sql:param>
    parameter value
</sql:param>
<sql:dateParam value="value" [type="{timestamp|time|date}"]/>
/foo/bar[@x=$param:name]
_boolean_
_number_
_string_
_node-set_
<c:import url="http://acme.com/productInfo" var="doc">
    <c:param name="productName" value="${product.name}"/>
</c:import>
<x:parse doc="${doc}" var="parsedDoc"/>
<!-- parse an XML document -->
<c:import url="http://acme.com/customer?id=76567" var="doc"/>
<x:parse doc="${doc}" var="parsedDoc"/>

<!-- access XML data via XPath expressions -->
<x:out select="$parsedDoc/name"/>
<x:out select="$parsedDoc/address"/>

<!-- set a scoped variable -->
<x:set var="custName" scope="request" select="$parsedDoc/name"/>
<!-- context set by ancestor tag <x:forEach> -->
<x:forEach select="$parsedDoc//customer">
    <x:out select="name"/>
</x:forEach>
<x:parse {doc="XMLDocument"|xml^[10]="XMLDocument"}
    {var="var" [scope="scope"]|varDom="var" [scopeDom="scope"]}
    [systemId="systemId"]
    [filter="filter"]/>
<x:parse
    {var="var" [scope="scope"]|varDom="var" [scopeDom="scope"]}
    [systemId="systemId"]
    [filter="filter"]>
        XML Document to parse
</x:parse>
<c:import url="http://acme.com/customers" var="doc"/>
    <x:parse doc="${doc}" filter="${filterEuropeanCust}"
            var="parsedDoc"/>
<x:out select="XPathExpression" [escapeXml="{true|false}"]/>
<x:set select="XPathExpression"
    var="varName" [scope="{page|request|session|application}"]/>
<x:if select="$customer/[location='UK']">
    UK based customer
</x:if>
<x:choose>
    <x:when select="$customer/firstName">
        Hello <x:out select="$customer/firstName"/>
    </x:when>
    <x:otherwise>
        Hello my friend
    </x:otherwise>
</x:choose>
<x:forEach select="$doc//author">
    <x:out select="@name"/>
</x:forEach>
<x:if select="XPathExpression"
        var="varName" [scope="{page|request|session|application}"]/>
<x:if select="XPathExpression"
        [var="varName"] [scope="{page|request|session|application}"]>
    body content
</x:if>
<x:choose>
    body content (<x:when> and <x:otherwise> subtags)
</x:choose>
<x:when select="XPathExpression">
    body content
</x:when>
<x:otherwise>
    conditional block
</x:otherwise>
<x:forEach [var="varName"] select="XPathExpression">
        [varStatus="varStatusName"]
        [begin="begin"] [end="end"] [step="step"]>
    body content
</x:forEach>
<c:import url="http://acme.com/customers" var="doc"/>
<c:import url="/WEB-INF/xslt/customerList.xsl" var="xslt"/>
<x:transform doc="${doc}" xslt="${xslt}"/>
<x:transform doc="${doc}" xslt="${xslt}">
    <x:param name="foo" value="foo-value"/>
</x:transform>
<x:transform
        {doc="XMLDocument"|xml^[12]="XMLDocument"} xslt="XSLTStylesheet"
        [{docSystemId="XMLSystemId"|xmlSystemId^[12]="XMLSystemId"}]
        [xsltSystemId="XSLTSystemId"]
        [{var="varName" [scope="scopeName"]|result="resultObject"}]
<x:transform
        {doc="XMLDocument"|xml1="XMLDocument"} xslt="XSLTStylesheet"
        [{docSystemId="XMLSystemId"|xmlSystemId^[12]="XMLSystemId"}]
        [xsltSystemId="XSLTSystemId"]
        [{var="varName" [scope="scopeName"]|result="resultObject"}]
    <x:param> actions
</x:transform>
<x:transform
        xslt="XSLTStylesheet"
        [{docSystemId="XMLSystemId"|xmlSystemId^[12]="XMLSystemId"}]
        xsltSystemId="XSLTSystemId"
        [{var="varName" [scope="scopeName"]|result="resultObject"}]
    XML Document to parse
    optional <x:param> actions
</x:transform>
<x:param name="name" value="value"/>
<x:param name="name">
    parameter value
</x:param>
<?xml version="1.0" encoding="UTF-8" ?>

<taglib 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"
    version="2.0">
    <description>
        Validates Jakarta Server Pages to prohibit use of scripting elements.
    </description>
    <tlib-version>1.0</tlib-version>
    <jsp-version>2.0</jsp.version>
    <short-name>scriptfree</short-name>
    <uri>http://acme.com/scriptfree</uri>

    <validator>
        <validator-class>
            jakarta.servlet.jsp.jstl.tlv.ScriptFreeTLV
        </validator-class>
        <init-param>
            <param-name>allowDeclarations</param-name>
            <param-value>false</param-value>
        </init-param>
        <init-param>
            <param-name>allowScriptlets</param-name>
            <param-value>false</param-value>
        </init-param>
        <init-param>
            <param-name>allowExpressions</param-name>
            <param-value>true</param-value>
        </init-param>
        <init-param>
            <param-name>allowRTExpressions</param-name>
            <param-value>true</param-value>
        </init-param>
    </validator>
</taglib>
<?xml version="1.0" encoding="UTF-8" ?>

<taglib
    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"
    version="2.0">
    <description>
        Restricts Jakarta Server Pages to the Jakarta Standard Tag Library tag libraries
    </description>
    <tlib-version>1.0</tlib-version>
    <jsp-version>2.0</jsp.version>
    <short-name>jstl taglibs only</scriptfree>
    <uri>http://acme.com/jstlTaglibsOnly</uri>

    <validator>
        <validator-class>
            jakarta.servlet.jsp.jstl.tlv.PermittedTaglibsTLV
        </validator-class>
        <init-param>
            <param-name>permittedTaglibs</param-name>
            <param-value>
                http://java.sun.com/jstl/core
                http://java.sun.com/jstl/xml
                http://java.sun.com/jstl/fmt
                http://java.sun.com/jstl/sql
            </param-value>
        </init-param>
    </validator>
</taglib>
There are ${fn:length(athletes)} athletes representing ${country}
<%-- truncate name to 30 chars and display it in uppercase --%>
${fn:toUpperCase(fn:substring(name, 0, 30))}

<%-- Display the text value prior to the first '*' character --%>
${fn:substringBefore(text, '*')}

<%-- Scoped variable "custId" may contain whitespaces at the beginning
or end. Trim it first, otherwise we end up with +'s in the URL --%>
<c:url var="myUrl" value="${base}/cust">
    <c:param name="custId" value="${fn:trim(custId)}"/>
</c:url>

<%-- Display the text in between brackets --%>
${fn:substring(text, fn:indexOf(text, '(')+1,
                     fn:indexOf(text, ')'))}

<%-- Display the name if it contains the search string --%>
<c:if test="${fn:containsIgnoreCase(name, searchString)}">
    Found name: ${name}
</c:if>

<%-- Display the last 10 characters of the text value --%>
${fn:substring(text, fn:length(text)-10)}

<%-- Display text value with bullets instead of '-' --%>
${fn:replace(text, '-', '&#149;')}
<%-- Escape XML characters when displaying
the value of a request parameter (avoid cross-site scripting) --%>

<input name="userName" value="${fn:escapeXml(param:userName)}">

<%-- Escape XML characters when passing an attribute value to an action --%>

<%-- Using <c:out> with <c:set>--%>
<c:set var="nameEscaped">
    <c:out value="${name}"/>
</c:set>
<my:tag name="${nameEscaped}"/>

<%-- Using <c:out> with <jsp:attribute>--%>
<my:tag>
    <jsp:attribute name="name">
        <c:out value="${name}"/>
    </jsp:attribute>
</my:tag>

<%-- Using fn:escapeXml --%>
<my:tag title="${fn:escapeXml(name)}"/>
fn:contains(string, substring) → boolean
fn:containsIgnoreCase(string, substring) → boolean
fn:endsWith(string, suffix) → boolean
fn:escapeXml(string) → String
fn:indexOf(string, substring) → int
fn:join(array, separator) → String
fn:length(input) → integer
fn:replace(inputString, beforeSubstring, afterSubstring) → String
fn:split(string, delimiters) → String[]
fn:startsWith(string, prefix) → boolean
fn:substring(string, beginIndex, endIndex) → String
fn:substringAfter(string, substring) → String
fn:substringBefore(string, substring) → String
fn:toLowerCase(string) → String
fn:toUpperCase(string) → String
fn:trim(string) → String

Name	Dyn	Type	Description
value	true	Object	Expression to be evaluated.
escapeXml	true	boolean	Determines whether characters <,>,&,'," in the resulting string should be converted to their corresponding character entity codes. Default value is true.
default	true	Object	Default value if the resulting value is null.

Name	Dyn	Type	Description
value	true	Object	Expression to be evaluated.
var	false	String	Name of the exported scoped variable to hold the value specified in the action. The type of the scoped variable is whatever type the value expression evaluates to.
scope	false	String	Scope for var.
target	true	Object	Target object whose property will be set. Must evaluate to a JavaBeans object with setter property property, or to a java.util.Map object.
property	true	String	Name of the property to be set in the target object.

Name	Dynamic	Type	Description
var	false	String	Name of the scoped variable to be removed.
scope	false	String	Scope for var.

Name	Dyn	Type	Description
test	true	boolean	The test condition that determines whether or not the body content should be processed.
var	false	String	Name of the exported scoped variable for the resulting value of the test condition. The type of the scoped variable is Boolean.
scope	false	String	Scope for var.

Name	Dyn	Type	Description
var	false	String	Name of the exported scoped variable for the current item of the iteration. This scoped variable has nested visibility. Its type depends on the object of the underlying collection.
items	true	Any of the supported types described in Section "Description" below.	Collection of items to iterate over.
varStatus	false	String	Name of the exported scoped variable for the status of the iteration. Object exported is of type jakarta.servlet.jsp.jstl.core.LoopTagStatus. This scoped variable has nested visibility.
begin	true	int	If items specified: Iteration begins at the item located at the specified index. First item of the collection has index 0. If items not specified: Iteration begins with index set at the value specified.
end	true	int	If items specified: Iteration ends at the item located at the specified index (inclusive). If items not specified: Iteration ends when index reaches the value specified.
step	true	int	Iteration will only process every step items of the collection, starting with the first one.

Name	Dynamic	Type	Description
url	true	String	The URL of the resource to import.
context	true	String	Name of the context when accessing a relative URL resource that belongs to a foreign context.
var	false	String	Name of the exported scoped variable for the resource’s content. The type of the scoped variable is String.
scope	false	String	Scope for var.
charEncoding	true	String	Character encoding of the content at the input resource.
varReader	false	String	Name of the exported scoped variable for the resource’s content. The type of the scoped variable is Reader.

Name	Dynamic	Type	Description
name	true	String	Name of the query string parameter.
value	true	String	Value of the parameter.

Name	Dynamic	Type	Description
value	true	String or java.util.Locale	A String value is interpreted as the printable representation of a locale, which must contain a two-letter (lower-case) language code (as defined by ISO-639), and may contain a two-letter (upper-case) country code (as defined by ISO-3166). Language and country codes must be separated by hyphen ('-') or underscore ('_').
variant	true	String	Vendor- or browser-specific variant. See the java.util.Locale Javadocs for more information on variants.
scope	false	String	Scope of the locale configuration variable.

Name	Dynamic	Type	Description
basename	true	String	Resource bundle base name. This is the bundle’s fully-qualified resource name, which has the same form as a fully-qualified class name, that is, it uses "." as the package component separator and does not have any file type (such as ".class" or ".properties") suffix.
prefix	true	String	Prefix to be prepended to the value of the message key of any nested `<fmt:message>` action.

Name	Dyn	Type	Description
key	true	String	Message key to be looked up.
bundle	true	LocalizationContext	Localization context in whose resource bundle the message key is looked up.
var	false	String	Name of the exported scoped variable which stores the localized message.
scope	false	String	Scope of var.

Name	Dyn	Type	Description
value	true	String or java.util.TimeZone	The time zone. A String value is interpreted as a time zone ID. This may be one of the time zone IDs supported by the Java platform (such as "America/Los_Angeles") or a custom time zone ID (such as "GMT-8"). See java.util.TimeZone for more information on supported time zone formats.
var	false	String	Name of the exported scoped variable which stores the time zone of type java.util.TimeZone.
scope	false	String	Scope of var or the time zone configuration variable.

Name	Dyn	Type	Description
value	true	String or Number	Numeric value to be formatted.
type	true	String	Specifies whether the value is to be formatted as number, currency, or percentage.
pattern	true	String	Custom formatting pattern.
currencyCode	true	String	ISO 4217 currency code. Applied only when formatting currencies (i.e. if type is equal to "currency"); ignored otherwise.
currencySymbol	true	String	Currency symbol. Applied only when formatting currencies (i.e. if type is equal to "currency"); ignored otherwise.
groupingUsed	true	boolean	Specifies whether the formatted output will contain any grouping separators.
maxIntegerDigits	true	int	Maximum number of digits in the integer portion of the formatted output.
minIntegerDigits	true	int	Minimum number of digits in the integer portion of the formatted output.
maxFractionDigits	true	int	Maximum number of digits in the fractional portion of the formatted output.
minFractionDigits	true	int	Minimum number of digits in the fractional portion of the formatted output.
var	false	String	Name of the exported scoped variable which stores the formatted result as a String.
scope	false	String	Scope of var.

Name	Dynamic	Type	Description
value	true	java.util. Date	Date and/or time to be formatted.
type	true	String	Specifies whether the time, the date, or both the time and date components of the given date are to be formatted.
dateStyle	true	String	Predefined formatting style for dates. Follows the semantics defined in class java.text.DateFormat. Applied only when formatting a date or both a date and time (i.e. if type is missing or is equal to "date" or "both"); ignored otherwise.
timeStyle	true	String	Predefined formatting style for times. Follows the semantics defined in class java.text.DateFormat. Applied only when formatting a time or both a date and time (i.e. if type is equal to "time" or "both"); ignored otherwise.
pattern	true	String	Custom formatting style for dates and times.
timeZone	true	String or java.util. TimeZone	Time zone in which to represent the formatted time.
var	false	String	Name of the exported scoped variable which stores the formatted result as a String.
scope	false	String	Scope of var.

Name	Dynamic	Type	Description
sql	true	String	SQL query statement.
dataSource	true	javax.sql.DataSource or String	Data source associated with the database to query. A String value represents a relative path to a JNDI resource or the parameters for the DriverManager class.
maxRows	true	int	The maximum number of rows to be included in the query result. If not specified, or set to -1, no limit on the maximum number of rows is enforced.
startRow	true	int	The returned Result object includes the rows starting at the specified index. The first row of the original query result set is at index 0. If not specified, rows are included starting from the first row at index 0.
var	false	String	Name of the exported scoped variable for the query result. The type of the scoped variable is jakarta.servlet.jsp.jstl.sql.Result.
scope	false	String	Scope of var.

Name	Dyn	Type	Description
dataSource	true	javax.sql. DataSource or String	DataSource associated with the database to access. A String value represents a relative path to a JNDI resource or the parameters for the JDBC DriverManager facility.
isolation	true	String	Transaction isolation level. If not specified, it is the isolation level the DataSource has been configured with.

Name	Dyn	Type	Description
dataSource	true	String or javax.sql.DataSource	Data source. If specified as a string, it can either be a relative path to a JNDI resource, or a JDBC parameters string as defined in Data Source.
driver	true	String	JDBC parameter: driver class name.
url	true	String	JDBC parameter: URL associated with the database.
user	true	String	JDBC parameter: database user on whose behalf the connection to the database is being made.
password	true	String	JDBC parameter: user password
var	false	String	Name of the exported scoped variable for the data source specified. Type can be String or DataSource.
scope	false	String	If var is specified, scope of the exported variable. Otherwise, scope of the data source configuration variable.

Name	Dyn	Type	Description
value	true	java.util.Date	Parameter value for DATE, TIME, or TIMESTAMP column in a database table.
type	true	String	One of "date", "time" or "timestamp".

Name	Dyn	Type	Description
doc	true	String, Reader	Source XML document to be parsed.
xml	true	String, Reader	Deprecated ^[11]. Use attribute doc instead.
systemId	true	String	The system identifier (URI) for parsing the XML document.
filter	true	org.xml.sax.XMLFilter	Filter to be applied to the source document.
var	false	String	Name of the exported scoped variable for the parsed XML document. The type of the scoped variable is implementation dependent.
scope	false	String	Scope for var.
varDom	false	String	Name of the exported scoped variable for the parsed XML document. The type of the scoped variable is org.w3c.dom.Document.
scopeDom	false	String	Scope for varDom.

Name	Dynamic	Type	Description
select	false	String	XPath expression to be evaluated.
escapeXml	true	boolean	Determines whether characters <,>,&,'," in the resulting string should be converted to their corresponding character entity codes. Default value is true.

Name	Dyn	Type	Description
doc	true	String, Reader, javax.xml.transform.Source, org.w3c.dom.Document, or object exported by <x:parse>, <x:set>.	Source XML document to be transformed. (If exported by <x:set>, it must correspond to a well-formed XML document, not a partial document.)
xml	true	String, Reader, javax.xml.transform.Source, org.w3c.dom.Document, or object exported by <x:parse>, <x:set>.	Deprecated ^[13]. Use attribute doc instead.
xslt	true	String, Reader or javax.xml.transform.Source	Transformation stylesheet as a String, Reader, or Source object.
docSystemId	true	String	The system identifier (URI) for parsing the XML document.
xmlSystemId	true	String	Deprecated 1. Use attribute docSystemId instead.
xsltSystemId	true	String	The system identifier (URI) for parsing the XSLT stylesheet.
var	false	String	Name of the exported scoped variable for the transformed XML document. The type of the scoped variable is org.w3c.dom.Document.
scope	false	String	Scope for var.
result	true	javax.xml.transform.Result	Object that captures or processes the transformation result.

Argument	Type	Description
string	String	The input string on which the function is applied.
substring	String	The substring tested for.
Result	boolean	true if the character sequence represented by the substring argument exists in the character sequence represented by the string argument, false otherwise.

Argument	Type	Description
string	String	The input string on which the conversion is applied.
Result	String	Converted string.

Argument	Type	Description
array	String[]	Array of strings to be joined.
separator	String	String to separate each element of the array in the resulting string.
Result	String	All array elements joined into one string.

Argument	Type	Description
input	Any of the types supported for the items attribute in the `<c:forEach>` action, or String.	The input collection or string on which the length is computed.
Result	int	Length of the collection or the string.

Argument	Type	Description
inputString	String	The input string on which the replace function is applied.
beforeSubstring	String	The "before" substring to be replaced.
afterSubstring	String	The "after" substring that replaces the "before" substring.
Result	String	The string that results from replacing beforeSubstring with afterSubstring.

Jakarta Standard Tag Library

Copyright

Eclipse Foundation Specification License

Disclaimers

Preface

Related Documentation

Typographical Conventions

Acknowledgments

Comments

1. Introduction

1.1. Goals

1.2. Multiple Tag Libraries

1.3. Container Requirement

2. Conventions

2.1. How Actions are Documented

2.1.1. Attributes

2.1.2. Syntax Notation

2.2. Scoped Variables

2.2.1. var and scope

2.2.2. Visibility

2.3. Static vs Dynamic Attribute Values

2.4. White Spaces

2.5. Body Content

2.6. Naming

2.7. Errors and Exceptions

2.8. Configuration Data

2.9. Default Values

3. Expression Language Overview

3.1. Expressions and Attribute Values

3.2. Accessing Application Data

3.3. Nested Properties and Accessing Collections

3.4. Operators

3.5. Automatic Type Conversion

3.6. Default Values

4. General-Purpose Actions: core tag library

4.1. Overview

4.2. <c:out>

4.3. <c:set>

4.4. <c:remove>

4.5. <c:catch>

5. Conditional Actions: core tag library

5.1. Overview

5.2. Custom Logic Actions

5.3. <c:if>

5.4. <c:choose>

5.5. <c:when>

5.6. <c:otherwise>

6. Iterator Actions: core tag library

6.1. Overview

6.1.1. Collections of Objects to Iterate Over

6.1.2. Map

6.1.3. Iteration Status

6.1.4. Range Attributes

6.1.5. Tag Collaboration

6.1.6. Deferred Values

6.2. <c:forEach>

6.3. <c:forTokens>

7. URL Related Actions: core tag library

7.1. Hypertext Links

7.2. Importing Resources

7.2.1. URL

7.2.2. Exporting an object: String or Reader

7.2.3. URL Encoding

7.2.4. Networking Properties

7.3. HTTP Redirect

7.4. <c:import>

7.5. <c:url>

7.6. <c:redirect>

7.7. <c:param>

8. Internationalization (i18n) Actions: I18n-capable formatting tag library

8.1. Overview

8.1.1. <fmt:message>

8.2. I18n Localization Context

8.2.1. Preferred Locales

8.3. Determinining the Resource Bundle for an i18n Localization Context

8.3.1. Resource Bundle Lookup

8.3.2. Resource Bundle Determination Algorithm

8.3.3. Examples

8.4. Response Encoding

8.5. <fmt:setLocale>

Argument	Type	Description
string	String	The input string that gets split into an array of substrings.
delimiters	String	Delimiter characters used to split the string.
Result	String[]	Array of strings.

Argument	Type	Description
string	String	The input string on which the substring function is applied.
beginIndex	int	The beginning index (0-based), inclusive.
endIndex	int	The ending index (0-based), exclusive .
Result	String	The substring of the input string.

Argument	Type	Description
string	String	The input string on which the transformation to lower case is applied.
Result	String	The input string transformed to lower case.

Argument	Type	Description
string	String	The input string on which the the transformation to upper case is applied.
Result	String	The input string transformed to upper case.

Argument	Type	Description
string	String	The input string on which the the trim is applied.
Result	String	The trimmed string.