KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > freemarker > template > TemplateDateModel


1 /*
2  * Copyright (c) 2003 The Visigoth Software Society. All rights
3  * reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in
14  * the documentation and/or other materials provided with the
15  * distribution.
16  *
17  * 3. The end-user documentation included with the redistribution, if
18  * any, must include the following acknowledgement:
19  * "This product includes software developed by the
20  * Visigoth Software Society (http://www.visigoths.org/)."
21  * Alternately, this acknowledgement may appear in the software itself,
22  * if and wherever such third-party acknowledgements normally appear.
23  *
24  * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
25  * project contributors may be used to endorse or promote products derived
26  * from this software without prior written permission. For written
27  * permission, please contact visigoths@visigoths.org.
28  *
29  * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
30  * nor may "FreeMarker" or "Visigoth" appear in their names
31  * without prior written permission of the Visigoth Software Society.
32  *
33  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
34  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
35  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
36  * DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
37  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
38  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
39  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
40  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
41  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
42  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
43  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44  * SUCH DAMAGE.
45  * ====================================================================
46  *
47  * This software consists of voluntary contributions made by many
48  * individuals on behalf of the Visigoth Software Society. For more
49  * information on the Visigoth Software Society, please see
50  * http://www.visigoths.org/
51  */
52
53 package freemarker.template;
54
55 import java.util.Arrays JavaDoc;
56 import java.util.Collections JavaDoc;
57 import java.util.Date JavaDoc;
58 import java.util.List JavaDoc;
59
60 /**
61  * Date values in a template data model must implement this interface.
62  * Contrary to Java, FreeMarker actually distinguishes values that represent
63  * only a time, only a date, or a combined date and time. All three are
64  * represented using this single interface, however there's a method that
65  *
66  * @author Attila Szegedi
67  *
68  * @version $Id: TemplateDateModel.java,v 1.10 2004/03/13 13:05:09 ddekany Exp $
69  */
70 public interface TemplateDateModel extends TemplateModel
71 {
72     /**
73      * It is not known whether the date model represents a time-only,
74      * a date-only, or a datetime value.
75      */
76     public static final int UNKNOWN = 0;
77
78     /**
79      * The date model represents a time-only value.
80      */
81     public static final int TIME = 1;
82
83     /**
84      * The date model represents a date-only value.
85      */
86     public static final int DATE = 2;
87
88     /**
89      * The date model represents a datetime value.
90      */
91     public static final int DATETIME = 3;
92     
93     public static final List JavaDoc TYPE_NAMES =
94         Collections.unmodifiableList(
95             Arrays.asList(
96                 new String JavaDoc[] {
97                     "UNKNOWN", "TIME", "DATE", "DATETIME"
98                 }));
99     /**
100      * Returns the date value. The return value must not be null.
101      * @return the {@link Date} instance associated with this date model.
102      */
103     public Date JavaDoc getAsDate() throws TemplateModelException;
104
105     /**
106      * Returns the type of the date. It can be any of <tt>TIME</tt>,
107      * <tt>DATE</tt>, or <tt>DATETIME</tt>.
108      */
109     public int getDateType();
110 }
111
Popular Tags