freemarker.ext.misc
Class Join

java.lang.Object
  freemarker.ext.misc.Join

All Implemented Interfaces:

TemplateMethodModel2, TemplateModel, java.io.Serializable

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

Replicates the standard Perl join function. Partners with the Split method model. Any sublists are joined along with the main list in a depth-first traversal order.

Usage:
From java:

 TemplateModelRoot root = new SimpleHash();

 root.put( "join", freemarker.ext.misc.Join.getInstance() );

 ...
 

From your FM-Classic template:

 The following creates a directory path:
 <assign path = [ "var", "log", "apache" ]>
 <assign output = join( "/", path )>
 /${output}

 ...
 

Since:

1.9

Version:

$Id: Join.java 1152 2013-04-15 10:34:50Z run2000 $

Author:

Nicholas Cull

See Also:

Serialized Form

Method Summary

TemplateModel	exec(java.util.List<TemplateModel> arguments) Executes a method call.
static Join	getInstance() Retrieve 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 Join getInstance()

Retrieve a singleton instance of this class. Since there is no state information held between calls, there is only a need for one instance.

Returns:

an instance of this Join class

isEmpty

public boolean isEmpty()
                throws TemplateModelException

Description copied from interface: TemplateModel

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

Description copied from interface: TemplateMethodModel2

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