freemarker.ext.misc
Class IsIndexed

java.lang.Object
  freemarker.ext.misc.IsIndexed

All Implemented Interfaces:

TemplateMethodModel2, TemplateModel, java.io.Serializable

public final class IsIndexed
extends java.lang.Object
implements TemplateMethodModel2, java.io.Serializable

Determines whether a given model is an instance of a TemplateListModel or TemplateIndexedModel.

Note:
IsIndexed is a singleton instance. Use the getInstance() method to retrieve instances of this model.

Since:

1.8

Version:

$Id: IsIndexed.java 1101 2013-04-01 04:17:32Z run2000 $

Author:

Nicholas Cull

See Also:

Serialized Form

Method Summary

TemplateModel	exec(java.util.List<TemplateModel> arguments) Executes a method call.
static IsIndexed	getInstance() Return a singleton instance of this class.
boolean	isEmpty() Is the object empty?

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static IsIndexed getInstance()

Return a singleton instance of this class.

Returns:

a new IsIndexed object

isEmpty

public boolean isEmpty()
                throws TemplateModelException

Is the object empty?

Specified by:

isEmpty in interface TemplateModel

Returns:

true if this object is empty, otherwise false

Throws:

TemplateModelException

exec

public TemplateModel exec(java.util.List<TemplateModel> arguments)
                   throws TemplateModelException

Executes a method call. Arguments are passed as a List of TemplateModel objects.

Specified by:

exec in interface TemplateMethodModel2

Parameters:

arguments - a List of TemplateModel objects containing the values of the arguments passed to the method.

Returns:

the TemplateModel produced by the method, or null.

Throws:

TemplateModelException