org.apache.taglibs.standard.tag.common.fmt.FormatDateSupport Maven / Gradle / Ivy
The newest version!
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the "License"). You may not use this file except
* in compliance with the License.
*
* You can obtain a copy of the license at
* glassfish/bootstrap/legal/CDDLv1.0.txt or
* https://glassfish.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* HEADER in each file and include the License file at
* glassfish/bootstrap/legal/CDDLv1.0.txt. If applicable,
* add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your
* own identifying information: Portions Copyright [yyyy]
* [name of copyright owner]
*
* Copyright 2005 Sun Microsystems, Inc. All rights reserved.
*
* Portions Copyright Apache Software Foundation.
*/
package org.apache.taglibs.standard.tag.common.fmt;
import java.io.IOException;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Locale;
import java.util.TimeZone;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspTagException;
import javax.servlet.jsp.PageContext;
import javax.servlet.jsp.tagext.TagSupport;
import org.apache.taglibs.standard.resources.Resources;
import org.apache.taglibs.standard.tag.common.core.Util;
/**
* Support for tag handlers for <formatDate>, the date and time
* formatting tag in JSTL 1.0.
*
* @author Jan Luehe
*/
public abstract class FormatDateSupport extends TagSupport {
//*********************************************************************
// Private constants
private static final String DATE = "date";
private static final String TIME = "time";
private static final String DATETIME = "both";
//*********************************************************************
// Protected state
protected Date value; // 'value' attribute
protected String type; // 'type' attribute
protected String pattern; // 'pattern' attribute
protected Object timeZone; // 'timeZone' attribute
protected String dateStyle; // 'dateStyle' attribute
protected String timeStyle; // 'timeStyle' attribute
//*********************************************************************
// Private state
private String var; // 'var' attribute
private int scope; // 'scope' attribute
//*********************************************************************
// Constructor and initialization
public FormatDateSupport() {
super();
init();
}
private void init() {
type = dateStyle = timeStyle = null;
pattern = var = null;
value = null;
timeZone = null;
scope = PageContext.PAGE_SCOPE;
}
//*********************************************************************
// Tag attributes known at translation time
public void setVar(String var) {
this.var = var;
}
public void setScope(String scope) {
this.scope = Util.getScope(scope);
}
//*********************************************************************
// Tag logic
/*
* Formats the given date and time.
*/
public int doEndTag() throws JspException {
String formatted = null;
if (value == null) {
if (var != null) {
pageContext.removeAttribute(var, scope);
}
return EVAL_PAGE;
}
// Create formatter
Locale locale = SetLocaleSupport.getFormattingLocale(
pageContext,
this,
true,
DateFormat.getAvailableLocales());
if (locale != null) {
DateFormat formatter = createFormatter(locale);
// Apply pattern, if present
if (pattern != null) {
try {
((SimpleDateFormat) formatter).applyPattern(pattern);
} catch (ClassCastException cce) {
formatter = new SimpleDateFormat(pattern, locale);
}
}
// Set time zone
TimeZone tz = null;
if ((timeZone instanceof String)
&& ((String) timeZone).equals("")) {
timeZone = null;
}
if (timeZone != null) {
if (timeZone instanceof String) {
tz = TimeZone.getTimeZone((String) timeZone);
} else if (timeZone instanceof TimeZone) {
tz = (TimeZone) timeZone;
} else {
throw new JspTagException(
Resources.getMessage("FORMAT_DATE_BAD_TIMEZONE"));
}
} else {
tz = TimeZoneSupport.getTimeZone(pageContext, this);
}
if (tz != null) {
formatter.setTimeZone(tz);
}
formatted = formatter.format(value);
} else {
// no formatting locale available, use Date.toString()
formatted = value.toString();
}
if (var != null) {
pageContext.setAttribute(var, formatted, scope);
} else {
try {
pageContext.getOut().print(formatted);
} catch (IOException ioe) {
throw new JspTagException(ioe.toString(), ioe);
}
}
return EVAL_PAGE;
}
// Releases any resources we may have (or inherit)
public void release() {
init();
}
//*********************************************************************
// Private utility methods
private DateFormat createFormatter(Locale loc) throws JspException {
DateFormat formatter = null;
if ((type == null) || DATE.equalsIgnoreCase(type)) {
formatter = DateFormat.getDateInstance(
Util.getStyle(dateStyle, "FORMAT_DATE_INVALID_DATE_STYLE"),
loc);
} else if (TIME.equalsIgnoreCase(type)) {
formatter = DateFormat.getTimeInstance(
Util.getStyle(timeStyle, "FORMAT_DATE_INVALID_TIME_STYLE"),
loc);
} else if (DATETIME.equalsIgnoreCase(type)) {
formatter = DateFormat.getDateTimeInstance(
Util.getStyle(dateStyle, "FORMAT_DATE_INVALID_DATE_STYLE"),
Util.getStyle(timeStyle, "FORMAT_DATE_INVALID_TIME_STYLE"),
loc);
} else {
throw new JspException(
Resources.getMessage("FORMAT_DATE_INVALID_TYPE",
type));
}
return formatter;
}
}