001: /*
002: * Copyright (c) 2003 The Visigoth Software Society. All rights
003: * reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions
007: * are met:
008: *
009: * 1. Redistributions of source code must retain the above copyright
010: * notice, this list of conditions and the following disclaimer.
011: *
012: * 2. Redistributions in binary form must reproduce the above copyright
013: * notice, this list of conditions and the following disclaimer in
014: * the documentation and/or other materials provided with the
015: * distribution.
016: *
017: * 3. The end-user documentation included with the redistribution, if
018: * any, must include the following acknowledgement:
019: * "This product includes software developed by the
020: * Visigoth Software Society (http://www.visigoths.org/)."
021: * Alternately, this acknowledgement may appear in the software itself,
022: * if and wherever such third-party acknowledgements normally appear.
023: *
024: * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
025: * project contributors may be used to endorse or promote products derived
026: * from this software without prior written permission. For written
027: * permission, please contact visigoths@visigoths.org.
028: *
029: * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
030: * nor may "FreeMarker" or "Visigoth" appear in their names
031: * without prior written permission of the Visigoth Software Society.
032: *
033: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
034: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
035: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
036: * DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
037: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
038: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
039: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
040: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
041: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
042: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
043: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
044: * SUCH DAMAGE.
045: * ====================================================================
046: *
047: * This software consists of voluntary contributions made by many
048: * individuals on behalf of the Visigoth Software Society. For more
049: * information on the Visigoth Software Society, please see
050: * http://www.visigoths.org/
051: */
052:
053: package freemarker.template;
054:
055: import java.util.Arrays;
056: import java.util.Collections;
057: import java.util.Date;
058: import java.util.List;
059:
060: /**
061: * Date values in a template data model must implement this interface.
062: * Contrary to Java, FreeMarker actually distinguishes values that represent
063: * only a time, only a date, or a combined date and time. All three are
064: * represented using this single interface, however there's a method that
065: *
066: * @author Attila Szegedi
067: *
068: * @version $Id: TemplateDateModel.java,v 1.10 2004/03/13 13:05:09 ddekany Exp $
069: */
070: public interface TemplateDateModel extends TemplateModel {
071: /**
072: * It is not known whether the date model represents a time-only,
073: * a date-only, or a datetime value.
074: */
075: public static final int UNKNOWN = 0;
076:
077: /**
078: * The date model represents a time-only value.
079: */
080: public static final int TIME = 1;
081:
082: /**
083: * The date model represents a date-only value.
084: */
085: public static final int DATE = 2;
086:
087: /**
088: * The date model represents a datetime value.
089: */
090: public static final int DATETIME = 3;
091:
092: public static final List TYPE_NAMES = Collections
093: .unmodifiableList(Arrays.asList(new String[] { "UNKNOWN",
094: "TIME", "DATE", "DATETIME" }));
095:
096: /**
097: * Returns the date value. The return value must not be null.
098: * @return the {@link Date} instance associated with this date model.
099: */
100: public Date getAsDate() throws TemplateModelException;
101:
102: /**
103: * Returns the type of the date. It can be any of <tt>TIME</tt>,
104: * <tt>DATE</tt>, or <tt>DATETIME</tt>.
105: */
106: public int getDateType();
107: }
|