TemplateConfigurationFactoryException (FreeMarker 2.3.27-nightly

X-Mailer: ASF-Git Admin Mailer Subject: [38/51] [partial] incubator-freemarker-site git commit: 2.3.28 preview Manual http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/ac5ee4db/builds/fm2.3.27/api/freemarker/cache/TemplateConfigurationFactoryException.html ---------------------------------------------------------------------- diff --git a/builds/fm2.3.27/api/freemarker/cache/TemplateConfigurationFactoryException.html b/builds/fm2.3.27/api/freemarker/cache/TemplateConfigurationFactoryException.html deleted file mode 100644 index d6c9ab4..0000000 --- a/builds/fm2.3.27/api/freemarker/cache/TemplateConfigurationFactoryException.html +++ /dev/null @@ -1,280 +0,0 @@ - - - - - - -TemplateConfigurationFactoryException (FreeMarker 2.3.27-nightly_20171005T081942Z-incubating 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
-
- java.lang.Throwable
- -
  - java.lang.Exception
  - -
    - freemarker.cache.TemplateConfigurationFactoryException
    -
  -
-

-
-
All Implemented Interfaces:
-
Serializable
-
-
-
-
```
public class TemplateConfigurationFactoryException
-extends Exception
```
-
Non-I/O exception thrown by TemplateConfigurationFactory-s.
-
-
Since:
-
2.3.24
-
See Also:
-
Serialized Form
-
-

- -

- - -

Constructor Summary

- - - - - - - - - - - -

Constructors
Constructor and Description
`TemplateConfigurationFactoryException(String message)`
`TemplateConfigurationFactoryException(String message, - Throwable cause)`

- -

- - -
Method Summary
-
- - - -
  Methods inherited from class java.lang.Throwable
  -addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
- - - -
  Methods inherited from class java.lang.Object
  -clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-

- -

- - -

Constructor Detail

- - - -

TemplateConfigurationFactoryException

public TemplateConfigurationFactoryException(String message)

- - - -

TemplateConfigurationFactoryException

public TemplateConfigurationFactoryException(String message,
-                                             Throwable cause)

- - -

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/ac5ee4db/builds/fm2.3.27/api/freemarker/cache/TemplateLoader.html ---------------------------------------------------------------------- diff --git a/builds/fm2.3.27/api/freemarker/cache/TemplateLoader.html b/builds/fm2.3.27/api/freemarker/cache/TemplateLoader.html deleted file mode 100644 index cf83675..0000000 --- a/builds/fm2.3.27/api/freemarker/cache/TemplateLoader.html +++ /dev/null @@ -1,388 +0,0 @@ - - - - - - -TemplateLoader (FreeMarker 2.3.27-nightly_20171005T081942Z-incubating API) - - - - - - - - -

- - -

Skip navigation links

- - - -

Prev Class
Next Class

Frames
No Frames

All Classes

- -

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

- - -

- - - -

-
-
All Known Subinterfaces:
-
StatefulTemplateLoader
-
-
-
All Known Implementing Classes:
-
ByteArrayTemplateLoader, ClassTemplateLoader, FileTemplateLoader, MultiTemplateLoader, StringTemplateLoader, URLTemplateLoader, WebappTemplateLoader
-
-
-
-
```
public interface TemplateLoader
```
-
FreeMarker loads template "files" through objects that implement this interface, - thus the templates need not be real files, and can come from any kind of data source - (like classpath, servlet context, database, etc). While FreeMarker provides a few - TemplateLoader implementations out-of-the-box, it's normal for embedding - frameworks to use their own implementations. - -
To set the TemplateLoader used by FreeMaker, use - Configuration.setTemplateLoader(TemplateLoader). - -
Implementations of this interface should be thread-safe. - -
Implementations should override Object.toString() to show information about from where the - TemplateLoader loads the templates. For example, for a template loader that loads template from database - table toString could return something like - "MyDatabaseTemplateLoader(user=\"cms\", table=\"mail_templates\")". This string will be shown in - TemplateNotFoundException exception messages, next to the template name. - -
For those who has to dig deeper, note that the TemplateLoader is actually stored inside - the TemplateCache of the Configuration, and is normally only accessed directly - by the TemplateCache, and templates are get via the TemplateCache API-s.
-

- -

- - -

Method Summary

- - - - - - - - - - - - - - - - - - - - - - -

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`closeTemplateSource(Object templateSource)` - Closes the template source, releasing any resources held that are only required for reading the template and/or - its metadata. -
`Object`	`findTemplateSource(String name)` - Finds the template in the backing storage and returns an object that identifies the storage location where the - template can be loaded from. -
`long`	`getLastModified(Object templateSource)` - Returns the time of last modification of the specified template source. -
`Reader`	`getReader(Object templateSource, - String encoding)` - Returns the character stream of a template represented by the specified template source. -

- -
- - - -
  Method Detail
  - - - -
  - -
    findTemplateSource
    -
```
Object findTemplateSource(String name)
-                   throws IOException
```
    -
    Finds the template in the backing storage and returns an object that identifies the storage location where the - template can be loaded from. See the return value for more information.
    -
    -
    Parameters:
    -
    name - The name (template root directory relative path) of the template, already localized and normalized by - the cache. It is completely up to the loader implementation to - interpret the name, however it should expect to receive hierarchical paths where path components are - separated by a slash (not backslash). Backslashes (or any other OS specific separator character) are - not considered as separators by FreeMarker, and thus they will not be replaced with slash before - passing to this method, so it's up to the template loader to handle them (say, by throwing an - exception that tells the user that the path (s)he has entered is invalid, as (s)he must use slash -- - typical mistake of Windows users). The passed names are always considered relative to some - loader-defined root location (often referred as the "template root directory"), and will never start - with a slash, nor will they contain a path component consisting of either a single or a double dot -- - these are all resolved by the template cache before passing the name to the loader. As a side effect, - paths that trivially reach outside template root directory, such as ../my.ftl, will be - rejected by the template cache, so they never reach the template loader. Note again, that if the path - uses backslash as path separator instead of slash as (the template loader should not accept that), the - normalization will not properly happen, as FreeMarker (the cache) recognizes only the slashes as - separators.
    -
    Returns:
    -
    An object representing the template source, which can be supplied in subsequent calls to - getLastModified(Object) and getReader(Object, String), when those are called on the - same TemplateLoader. null must be returned if the source for the template doesn't exist; - don't throw exception then! The exact type of this object is up to the TemplateLoader - implementation. As this object is possibly used as hash key in caches, and is surly compared with another - template source for equality, it must have a proper Object.equals(Object) and - Object.hashCode()) implementation. Especially, template sources that refer to the same - physical source must be equivalent, otherwise template caching can become inefficient. This is only - expected from Object.equals(Object) when the compared template sources came from the same - TemplateLoader instance. Also, it must not influence the equality if the source is open or - closed (closeTemplateSource(Object)).
    -
    Throws:
    -
    IOException - When an error occurs that makes it impossible to find out if the template exists, or to access the - existing template. Don't throw exception if the template doesn't exist, instead return with - null then!
    -
    -
  - - - -
  - -
    getLastModified
    -
```
long getLastModified(Object templateSource)
```
    -
    Returns the time of last modification of the specified template source. This method is called after - findTemplateSource().
    -
    -
    Parameters:
    -
    templateSource - an object representing a template source, obtained through a prior call to - findTemplateSource(String). This must be an object on which - closeTemplateSource(Object) wasn't applied yet.
    -
    Returns:
    -
    the time of last modification of the specified template source, or -1 if the time is not known.
    -
    -
  - - - -
  - -
    getReader
    -
```
Reader getReader(Object templateSource,
-                 String encoding)
-          throws IOException
```
    -
    Returns the character stream of a template represented by the specified template source. This method is possibly - called for multiple times for the same template source object, and it must always return a Reader that - reads the template from its beginning. Before this method is called for the second time (or later), its caller - must close the previously returned Reader, and it must not use it anymore. That is, this method is not - required to support multiple concurrent readers for the same source templateSource object. - -
    - Typically, this method is called if the template is missing from the cache, or if after calling - findTemplateSource(String) and getLastModified(Object) it was determined that the cached copy - of the template is stale. Then, if it turns out that the encoding parameter used doesn't match the actual - template content (based on the #ftl encoding=... header), this method will be called for a second time - with the correct encoding parameter value.
    -
    -
    Parameters:
    -
    templateSource - an object representing a template source, obtained through a prior call to - findTemplateSource(String). This must be an object on which - closeTemplateSource(Object) wasn't applied yet.
    -
    encoding - the character encoding used to translate source bytes to characters. Some loaders may not have access - to the byte representation of the template stream, and instead directly obtain a character stream. - These loaders should ignore the encoding parameter.
    -
    Returns:
    -
    A Reader representing the template character stream. It's the responsibility of the caller (which - is TemplateCache usually) to close() it. The Reader is not required to work after - the templateSource was closed (closeTemplateSource(Object)).
    -
    Throws:
    -
    IOException - if an I/O error occurs while accessing the stream.
    -
    -
  - - - -
  - -
    closeTemplateSource
    -
```
void closeTemplateSource(Object templateSource)
-                  throws IOException
```
    -
    Closes the template source, releasing any resources held that are only required for reading the template and/or - its metadata. This is the last method that is called by the TemplateCache for a template source, except - that Object.equals(Object) is might called later too. TemplateCache ensures that this method will - be called on every object that is returned from findTemplateSource(String).
    -
    -
    Parameters:
    -
    templateSource - the template source that should be closed.
    -
    Throws:
    -
    IOException
    -
    -
  -
-

- - -

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/ac5ee4db/builds/fm2.3.27/api/freemarker/cache/TemplateLookupContext.html ---------------------------------------------------------------------- diff --git a/builds/fm2.3.27/api/freemarker/cache/TemplateLookupContext.html b/builds/fm2.3.27/api/freemarker/cache/TemplateLookupContext.html deleted file mode 100644 index 4f61f40..0000000 --- a/builds/fm2.3.27/api/freemarker/cache/TemplateLookupContext.html +++ /dev/null @@ -1,367 +0,0 @@ - - - - - - -TemplateLookupContext (FreeMarker 2.3.27-nightly_20171005T081942Z-incubating 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.cache.TemplateLookupContext
-

-
-
-
```
public abstract class TemplateLookupContext
-extends Object
```
-
Used as the parameter of TemplateLookupStrategy.lookup(TemplateLookupContext). - You can't create instances of this, only receive them from FreeMarker.
-
-
Since:
-
2.3.22
-
-

- -

- - -

Method Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`TemplateLookupResult`	`createNegativeLookupResult()` - Creates a not-found lookup result that then can be used as the return value of - `TemplateLookupStrategy.lookup(TemplateLookupContext)`. -
`Object`	`getCustomLookupCondition()` - Returns the value of the `customLookupCondition` parameter of - `Configuration.getTemplate(String, Locale, Object, String, boolean, boolean)`; see requirements there, such - as having a proper `Object.equals(Object)` and `Object.hashCode()` method. -
`Locale`	`getTemplateLocale()` - `null` if localized lookup is disabled (see `Configuration.getLocalizedLookup()`), otherwise the - locale requested. -
`String`	`getTemplateName()` - The normalized name (path) of the template (relatively to the `TemplateLoader`). -
`abstract TemplateLookupResult`	`lookupWithAcquisitionStrategy(String templateName)` - Finds the template source based on its normalized name; handles `*` steps (so called acquisition), - otherwise it just calls `TemplateLoader.findTemplateSource(String)`. -
`abstract TemplateLookupResult`	`lookupWithLocalizedThenAcquisitionStrategy(String templateName, - Locale templateLocale)` - Finds the template source based on its normalized name; tries localized variations going from most - specific to less specific, and for each variation it delegates to `lookupWithAcquisitionStrategy(String)`. -

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

- -
- - - -
  Method Detail
  - - - -
  - -
    lookupWithAcquisitionStrategy
    -
```
public abstract TemplateLookupResult lookupWithAcquisitionStrategy(String templateName)
-                                                            throws IOException
```
    -
    Finds the template source based on its normalized name; handles * steps (so called acquisition), - otherwise it just calls TemplateLoader.findTemplateSource(String).
    -
    -
    Parameters:
    -
    templateName - Must be a normalized name, like "foo/bar/baaz.ftl". A name is not normalized when, among - others, it starts with /, or contains . or .. path steps, or it uses - backslash (\) instead of /. A normalized name might contains "*" path steps - (acquisition).
    -
    Returns:
    -
    The result of the lookup. Not null; check TemplateLookupResult.isPositive() to see if the - lookup has found anything.
    -
    Throws:
    -
    IOException
    -
    -
  - - - -
  - -
    lookupWithLocalizedThenAcquisitionStrategy
    -
```
public abstract TemplateLookupResult lookupWithLocalizedThenAcquisitionStrategy(String templateName,
-                                                                                Locale templateLocale)
-                                                                         throws IOException
```
    -
    Finds the template source based on its normalized name; tries localized variations going from most - specific to less specific, and for each variation it delegates to lookupWithAcquisitionStrategy(String). - If templateLocale is null (typically, because Configuration.getLocalizedLookup() is - false)), then it's the same as calling lookupWithAcquisitionStrategy(String) directly. This is - the default strategy of FreeMarker (at least in 2.3.x), so for more information, see - TemplateLookupStrategy.DEFAULT_2_3_0.
    -
    -
    Throws:
    -
    IOException
    -
    -
  - - - -
  - -
    getTemplateName
    -
```
public String getTemplateName()
```
    -
    The normalized name (path) of the template (relatively to the TemplateLoader). Not null.
    -
  - - - -
  - -
    getTemplateLocale
    -
```
public Locale getTemplateLocale()
```
    -
    null if localized lookup is disabled (see Configuration.getLocalizedLookup()), otherwise the - locale requested.
    -
  - - - -
  - -
    getCustomLookupCondition
    -
```
public Object getCustomLookupCondition()
```
    -
    Returns the value of the customLookupCondition parameter of - Configuration.getTemplate(String, Locale, Object, String, boolean, boolean); see requirements there, such - as having a proper Object.equals(Object) and Object.hashCode() method. The interpretation of this - value is up to the custom TemplateLookupStrategy. Usually, it's used similarly to as the default lookup - strategy uses getTemplateLocale(), that is, to look for a template variation that satisfies the - condition, and then maybe fall back to more generic template if that's missing.
    -
  - - - -
  - -
    createNegativeLookupResult
    -
```
public TemplateLookupResult createNegativeLookupResult()
```
    -
    Creates a not-found lookup result that then can be used as the return value of - TemplateLookupStrategy.lookup(TemplateLookupContext). (In the current implementation it just always - returns the same static singleton, but that might need to change in the future.)
    -
  -
-

- - -

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/ac5ee4db/builds/fm2.3.27/api/freemarker/cache/TemplateLookupResult.html ---------------------------------------------------------------------- diff --git a/builds/fm2.3.27/api/freemarker/cache/TemplateLookupResult.html b/builds/fm2.3.27/api/freemarker/cache/TemplateLookupResult.html deleted file mode 100644 index 7527af8..0000000 --- a/builds/fm2.3.27/api/freemarker/cache/TemplateLookupResult.html +++ /dev/null @@ -1,266 +0,0 @@ - - - - - - -TemplateLookupResult (FreeMarker 2.3.27-nightly_20171005T081942Z-incubating 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.cache.TemplateLookupResult
-

-
-
-
```
public abstract class TemplateLookupResult
-extends Object
```
-
The return value of TemplateLookupStrategy.lookup(TemplateLookupContext) and similar lookup methods. You - usually get one from TemplateLookupContext.lookupWithAcquisitionStrategy(String) or - TemplateLookupContext.createNegativeLookupResult(); you can't create instances of this directly.
-
-
Since:
-
2.3.22
-
-

- -

- - -

Method Summary

- - - - - - - - - - - - - - -

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`abstract String`	`getTemplateSourceName()` - The source name of the template found (see `Template.getSourceName()`), or `null` if - `isPositive()` is `false`. -
`abstract boolean`	`isPositive()` - Tells if the lookup has found a matching template. -

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

- -
- - - -
  Method Detail
  - - - -
  - -
    getTemplateSourceName
    -
```
public abstract String getTemplateSourceName()
```
    -
    The source name of the template found (see Template.getSourceName()), or null if - isPositive() is false.
    -
  - - - -
  - -
    isPositive
    -
```
public abstract boolean isPositive()
```
    -
    Tells if the lookup has found a matching template.
    -
  -
-

- - -

Skip navigation links

- - - -

Prev Class
Next Class

Frames
No Frames

All Classes

- -

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

- - -

Class TemplateConfigurationFactoryException

Constructor Summary

Method Summary

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Constructor Detail

TemplateConfigurationFactoryException

TemplateConfigurationFactoryException

Interface TemplateLoader

Method Summary

Method Detail

findTemplateSource

getLastModified

getReader

closeTemplateSource

Class TemplateLookupContext

Method Summary

Methods inherited from class java.lang.Object

Method Detail

lookupWithAcquisitionStrategy

lookupWithLocalizedThenAcquisitionStrategy

getTemplateName

getTemplateLocale

getCustomLookupCondition

createNegativeLookupResult

Class TemplateLookupResult

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getTemplateSourceName

isPositive