TemplateDateFormat (FreeMarker 2.3.24-pre01 API)

; Tue, 3 Nov 2015 23:03:32 +0000 (UTC) Received: (qmail 12395 invoked by uid 99); 3 Nov 2015 23:03:31 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 03 Nov 2015 23:03:31 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id D4AAAE03E8; Tue, 3 Nov 2015 23:03:31 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: ddekany@apache.org To: notifications@freemarker.incubator.apache.org Date: Tue, 03 Nov 2015 23:03:45 -0000 Message-Id: <5c3749220efa452a87e7845a58b2136d@git.apache.org> In-Reply-To: <240b8761679d42cc9fbf47d1ca4a3861@git.apache.org> References: <240b8761679d42cc9fbf47d1ca4a3861@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [15/51] [partial] incubator-freemarker-site git commit: Uploaded freemarker.org/builds content from the previous (non-ASF) server http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/b35e4aa5/builds/2.3.24-pre01/_html/api/freemarker/core/TemplateDateFormat.html ---------------------------------------------------------------------- diff --git a/builds/2.3.24-pre01/_html/api/freemarker/core/TemplateDateFormat.html b/builds/2.3.24-pre01/_html/api/freemarker/core/TemplateDateFormat.html new file mode 100644 index 0000000..e686386 --- /dev/null +++ b/builds/2.3.24-pre01/_html/api/freemarker/core/TemplateDateFormat.html @@ -0,0 +1,442 @@ + + + + + + +TemplateDateFormat (FreeMarker 2.3.24-pre01 API) + + + + + + + + +

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

java.lang.Object
+
- freemarker.core.TemplateDateFormat
+

+
+
+
```
public abstract class TemplateDateFormat
+extends Object
```
+
Represents a date/time/dateTime format; used in templates for formatting and parsing with that format. This is + similar to Java's DateFormat, but made to fit the requirements of FreeMarker. Also, it makes easier to define + formats that can't be represented with Java's existing DateFormat implementations. + +
+ Implementations need not be thread-safe if the TemplateNumberFormatFactory doesn't recycle them among + different Environment-s. As far as FreeMarker's concerned, instances are bound to a single + Environment, and Environment-s are thread-local objects.
+
+
Since:
+
2.3.24
+
+

+ +

+ + +
Constructor Summary
+ + + + + + + + +
Constructors
Constructor and Description
TemplateDateFormat()
+

Constructors
Constructor and Description
`TemplateDateFormat()`

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract String`	`format(TemplateDateModel dateModel)`
`abstract <MO extends TemplateMarkupOutputModel> MO`	`format(TemplateDateModel dateModel, + MarkupOutputFormat<MO> outputFormat)` + [Not yet used, might changes in 2.3.24 final] + Formats the date/time/dateTime to markup instead of to plain text, or returns `null` that will make + FreeMarker call `format(TemplateDateModel)` and escape its result. +
`<MO extends TemplateMarkupOutputModel> boolean`	`format(TemplateDateModel dateModel, + MarkupOutputFormat<MO> outputFormat, + Writer out)` + [Not yet used, might changes in 2.3.24 final] + Same as `format(TemplateDateModel, MarkupOutputFormat)`, but prints the result to a `Writer` + instead of returning it. +
`abstract String`	`getDescription()` + Meant to be used in error messages to tell what format the parsed string didn't fit. +
`abstract boolean`	`isLocaleBound()` + Tells if this formatter should be re-created if the locale changes. +
`abstract boolean`	`isTimeZoneBound()` + Tells if this formatter should be re-created if the time zone changes. +
`abstract Date`	`parse(String s)` + [Unfinished - will change in 2.3.24 final]. +

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    TemplateDateFormat
    +
```
public TemplateDateFormat()
```
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    format
    +
```
public abstract String format(TemplateDateModel dateModel)
+                       throws UnformattableDateException,
+                              TemplateModelException
```
    +
    +
    Parameters:
    +
    dateModel - The date/time/dateTime to format. Most implementations will just work with the return value of + TemplateDateModel.getAsDate(), but some may format differently depending on the properties of + a custom TemplateDateModel implementation.
    +
    Returns:
    +
    The date/time/dateTime as text, with no escaping (like no HTML escaping). Can't be null.
    +
    Throws:
    +
    UnformattableDateException - When a TemplateDateModel can't be formatted because of the + value/properties of the TemplateDateModel. The most often used subclass is + UnknownDateTypeFormattingUnsupportedException.
    +
    TemplateModelException - Exception thrown by the dateModel object when calling its methods.
    +
    +
  + + + +
  - +
    format
    +
```
public abstract <MO extends TemplateMarkupOutputModel> MO format(TemplateDateModel dateModel,
+                                                                 MarkupOutputFormat<MO> outputFormat)
+                                                          throws UnformattableNumberException,
+                                                                 TemplateModelException
```
    +
    [Not yet used, might changes in 2.3.24 final] + Formats the date/time/dateTime to markup instead of to plain text, or returns null that will make + FreeMarker call format(TemplateDateModel) and escape its result. If the markup format would be just the + result of format(TemplateDateModel) escaped, it should return null.
    +
    +
    Throws:
    +
    UnformattableNumberException
    +
    TemplateModelException
    +
    +
  + + + +
  - +
    format
    +
```
public <MO extends TemplateMarkupOutputModel> boolean format(TemplateDateModel dateModel,
+                                                             MarkupOutputFormat<MO> outputFormat,
+                                                             Writer out)
+                                                      throws UnformattableNumberException,
+                                                             TemplateModelException,
+                                                             IOException
```
    +
    [Not yet used, might changes in 2.3.24 final] + Same as format(TemplateDateModel, MarkupOutputFormat), but prints the result to a Writer + instead of returning it. This can be utilized for some optimizatoin. In the case where + format(TemplateDateModel, MarkupOutputFormat) would return null, it returns false. It + writes to the Writer exactly if the return value is true. + +
    + The default implementation in TemplateNumberFormat builds on calls + format(TemplateDateModel, MarkupOutputFormat) and writes its result to the Writer.
    +
    +
    Throws:
    +
    UnformattableNumberException
    +
    TemplateModelException
    +
    IOException
    +
    +
  + + + +
  - +
    parse
    +
```
public abstract Date parse(String s)
+                    throws ParseException
```
    +
    [Unfinished - will change in 2.3.24 final]. + + TODO Thrown exceptions. + TODO How can one return a TemplateDateModel instead?
    +
    +
    Returns:
    +
    The interpretation of the text as Date. Can't be null.
    +
    Throws:
    +
    ParseException
    +
    +
  + + + +
  - +
    getDescription
    +
```
public abstract String getDescription()
```
    +
    Meant to be used in error messages to tell what format the parsed string didn't fit.
    +
  + + + +
  - +
    isLocaleBound
    +
```
public abstract boolean isLocaleBound()
```
    +
    Tells if this formatter should be re-created if the locale changes.
    +
  + + + +
  - +
    isTimeZoneBound
    +
```
public abstract boolean isTimeZoneBound()
```
    +
    Tells if this formatter should be re-created if the time zone changes. Currently always true.
    +
  +
+

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/b35e4aa5/builds/2.3.24-pre01/_html/api/freemarker/core/TemplateDateFormatFactory.html ---------------------------------------------------------------------- diff --git a/builds/2.3.24-pre01/_html/api/freemarker/core/TemplateDateFormatFactory.html b/builds/2.3.24-pre01/_html/api/freemarker/core/TemplateDateFormatFactory.html new file mode 100644 index 0000000..c633887 --- /dev/null +++ b/builds/2.3.24-pre01/_html/api/freemarker/core/TemplateDateFormatFactory.html @@ -0,0 +1,334 @@ + + + + + + +TemplateDateFormatFactory (FreeMarker 2.3.24-pre01 API) + + + + + + + + +

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

java.lang.Object
+
- freemarker.core.TemplateDateFormatFactory
+

+
+
+
```
public abstract class TemplateDateFormatFactory
+extends Object
```
+
Factory for a certain type of date/time/dateTime formatting (TemplateDateFormat). Usually a singleton + (one-per-VM or one-per-Configuration), and so must be thread-safe.
+
+
Since:
+
2.3.24
+
+

+ +

+ + +
Constructor Summary
+ + + + + + + + +
Constructors
Constructor and Description
TemplateDateFormatFactory()
+

Constructors
Constructor and Description
`TemplateDateFormatFactory()`

+ +

+ + +

Method Summary

+ + + + + + + + + + +

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`abstract TemplateDateFormat`	`get(int dateType, + boolean zonelessInput, + String params, + Locale locale, + TimeZone timeZone, + Environment env)` + Returns a formatter for the given parameters. +

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    TemplateDateFormatFactory
    +
```
public TemplateDateFormatFactory()
```
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    get
    +
```
public abstract TemplateDateFormat get(int dateType,
+                                       boolean zonelessInput,
+                                       String params,
+                                       Locale locale,
+                                       TimeZone timeZone,
+                                       Environment env)
+                                throws TemplateModelException,
+                                       UnknownDateTypeFormattingUnsupportedException,
+                                       InvalidFormatParametersException
```
    +
    Returns a formatter for the given parameters. + +
    + The returned formatter can be a new instance or a reused (cached) instance. Note that Environment itself + caches the returned instances, though that cache is lost with the Environment (i.e., when the top-level + template execution ends), also it might flushes lot of entries if the locale or time zone is changed during + template execution. So caching on the factory level is still useful, unless creating the formatters is + sufficiently cheap.
    +
    +
    Parameters:
    +
    dateType - TemplateDateModel.DATE, TemplateDateModel.TIME, TemplateDateModel.DATETIME or + TemplateDateModel.UNKNOWN. Supporting TemplateDateModel.UNKNOWN is not necessary, in + which case the method should throw an UnknownDateTypeFormattingUnsupportedException exception.
    +
    zonelessInput - Indicates that the input Java Date is not from a time zone aware source. When this is + true, the formatters shouldn't override the time zone provided to its constructor (most + formatters don't do that anyway), and it shouldn't show the time zone, if it can hide it (like a + SimpleDateFormat pattern-based formatter may can't do that, as the pattern prescribes what to + show). + +
    + As of FreeMarker 2.3.21, this is true exactly when the date is an SQL "date without time of + the day" (i.e., a java.sql.Date) or an SQL "time of the day" value (i.e., a + java.sql.Time, although this rule can change in future, depending on + configuration settings and such, so you should rely on this rule, just accept what this parameter + says.
    +
    params - The string that further describes how the format should look. For example, when the + dateFormat is "@fooBar 1, 2", then it will be + "1, 2" (and "@fooBar" selects the factory). The format of this string is up to the + TemplateDateFormatFactory implementation. Not null, often an empty string.
    +
    locale - The locale to format for. Not null. The resulting format should be bound to this locale + forever (i.e. locale changes in the Environment shouldn't be followed).
    +
    timeZone - The time zone to format for. Not null. The resulting format should be bound to this time zone + forever (i.e. time zone changes in the Environment shouldn't be followed).
    +
    env - The runtime environment from which the formatting was called. This is mostly meant to be used for + Environment.setCustomState(Object, Object)/Environment.getCustomState(Object).
    +
    Throws:
    +
    InvalidFormatParametersException - if the params is malformed
    +
    TemplateModelException - if the dateType is unsupported by the formatter
    +
    UnknownDateTypeFormattingUnsupportedException - if dateType is TemplateDateModel.UNKNOWN, and that's unsupported by the formatter + implementation.
    +
    +
  +
+

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/b35e4aa5/builds/2.3.24-pre01/_html/api/freemarker/core/TemplateFormatUtil.html ---------------------------------------------------------------------- diff --git a/builds/2.3.24-pre01/_html/api/freemarker/core/TemplateFormatUtil.html b/builds/2.3.24-pre01/_html/api/freemarker/core/TemplateFormatUtil.html new file mode 100644 index 0000000..6e666f6 --- /dev/null +++ b/builds/2.3.24-pre01/_html/api/freemarker/core/TemplateFormatUtil.html @@ -0,0 +1,295 @@ + + + + + + +TemplateFormatUtil (FreeMarker 2.3.24-pre01 API) + + + + + + + + +

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

java.lang.Object
+
- freemarker.core.TemplateFormatUtil
+

+
+

public final class TemplateFormatUtil
+extends Object

Since:: 2.3.24

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + +

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`checkHasNoParameters(String params)`
`static Date`	`getNonNullDate(TemplateDateModel dateModel)` + Utility method to extract the `Date` from an `TemplateDateModel`, and throw + `UnformattableDateException` with a standard error message if that's `null`. +
`static Number`	`getNonNullNumber(TemplateNumberModel numberModel)` + Utility method to extract the `Number` from an `TemplateNumberModel`, and throw + `UnformattableNumberException` with a standard error message if that's `null`. +

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +
- + + +
  Method Detail
  + + + +
  - +
    checkHasNoParameters
    +
```
public static void checkHasNoParameters(String params)
+                                 throws InvalidFormatParametersException
```
    +
    +
    Throws:
    +
    InvalidFormatParametersException
    +
    +
  + + + +
  - +
    getNonNullNumber
    +
```
public static Number getNonNullNumber(TemplateNumberModel numberModel)
+                               throws TemplateModelException,
+                                      UnformattableNumberException
```
    +
    Utility method to extract the Number from an TemplateNumberModel, and throw + UnformattableNumberException with a standard error message if that's null.
    +
    +
    Throws:
    +
    TemplateModelException
    +
    UnformattableNumberException
    +
    +
  + + + +
  - +
    getNonNullDate
    +
```
public static Date getNonNullDate(TemplateDateModel dateModel)
+                           throws TemplateModelException
```
    +
    Utility method to extract the Date from an TemplateDateModel, and throw + UnformattableDateException with a standard error message if that's null.
    +
    +
    Throws:
    +
    TemplateModelException
    +
    +
  +
+

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/b35e4aa5/builds/2.3.24-pre01/_html/api/freemarker/core/TemplateHTMLOutputModel.html ---------------------------------------------------------------------- diff --git a/builds/2.3.24-pre01/_html/api/freemarker/core/TemplateHTMLOutputModel.html b/builds/2.3.24-pre01/_html/api/freemarker/core/TemplateHTMLOutputModel.html new file mode 100644 index 0000000..df6065a --- /dev/null +++ b/builds/2.3.24-pre01/_html/api/freemarker/core/TemplateHTMLOutputModel.html @@ -0,0 +1,273 @@ + + + + + + +TemplateHTMLOutputModel (FreeMarker 2.3.24-pre01 API) + + + + + + + + +

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

java.lang.Object
+
- freemarker.core.CommonTemplateMarkupOutputModel<TemplateHTMLOutputModel>
- +
  - freemarker.core.TemplateHTMLOutputModel
  +
+

+
+
All Implemented Interfaces:
+
TemplateMarkupOutputModel<TemplateHTMLOutputModel>, TemplateModel
+
+
+
+
```
public final class TemplateHTMLOutputModel
+extends CommonTemplateMarkupOutputModel<TemplateHTMLOutputModel>
```
+
Stores HTML markup to be printed; used with HTMLOutputFormat.
+
+
Since:
+
2.3.24
+
+

+ +
- + + +
  Field Summary
  +
  - + + +
    Fields inherited from interface freemarker.template.TemplateModel
    +NOTHING
  +
+ +
- + + +
  Method Summary
  + + + + + + + + + + +
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method and Description
  HTMLOutputFormat getOutputFormat()
  +
  - + + +
    Methods inherited from class java.lang.Object
    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  +
+

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HTMLOutputFormat`	`getOutputFormat()`

+ +
- + + +
  Method Detail
  + + + +
  - +
    getOutputFormat
    +
```
public HTMLOutputFormat getOutputFormat()
```
    +
    +
    Specified by:
    +
    getOutputFormat in interface TemplateMarkupOutputModel<TemplateHTMLOutputModel>
    +
    Specified by:
    +
    getOutputFormat in class CommonTemplateMarkupOutputModel<TemplateHTMLOutputModel>
    +
    +
  +
+

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

Class TemplateDateFormat

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TemplateDateFormat

Method Detail

format

format

format

parse

getDescription

isLocaleBound

isTimeZoneBound

Class TemplateDateFormatFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TemplateDateFormatFactory

Method Detail

get

Class TemplateFormatUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

checkHasNoParameters

getNonNullNumber

getNonNullDate

Class TemplateHTMLOutputModel

Field Summary

Fields inherited from interface freemarker.template.TemplateModel

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getOutputFormat