Interface TemplateDateModel

All Superinterfaces:
TemplateModel
All Known Implementing Classes:
SimpleDate

public interface TemplateDateModel extends TemplateModel
Date values in a template data model must implement this interface. Contrary to Java, FreeMarker actually distinguishes values that represent only a time, only a date, or a combined date and time. All three are represented using this single interface, however there's a method that
  • Field Details

    • UNKNOWN

      static final int UNKNOWN
      It is not known whether the date model represents a time-only, a date-only, or a datetime value.
      See Also:
    • TIME

      static final int TIME
      The date model represents a time-only value.
      See Also:
    • DATE

      static final int DATE
      The date model represents a date-only value.
      See Also:
    • DATETIME

      static final int DATETIME
      The date model represents a datetime value.
      See Also:
    • TYPE_NAMES

      static final List TYPE_NAMES
  • Method Details

    • getAsDate

      Date getAsDate() throws TemplateModelException
      Returns the date value. The return value must not be null.
      Returns:
      the Date instance associated with this date model.
      Throws:
      TemplateModelException
    • getDateType

      int getDateType()
      Returns the type of the date. It can be any of TIME, DATE, or DATETIME.