Package com.atlassian.confluence.plugins.soy

Class PutMetadataFunction

java.lang.Object

com.atlassian.confluence.plugins.soy.PutMetadataFunction

All Implemented Interfaces:

com.atlassian.soy.renderer.SoyFunction, com.atlassian.soy.renderer.SoyServerFunction<Boolean>

public class PutMetadataFunction
extends Object
implements com.atlassian.soy.renderer.SoyServerFunction<Boolean>

A soy server function that Adds key-value String pairs to a map to be rendered later.

Usage: {if putMetadata($metadata.key, $metadata.value)}

Constructor Summary

Constructors

Constructor	Description
PutMetadataFunction(ConfluenceWebResourceManager webResourceManager)

Method Summary

Modifier and Type	Method	Description
Boolean	apply(Object... args)
String	getName()
Set<Integer>	validArgSizes()

Methods inherited from class java.lang.Object

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

Constructor Details

PutMetadataFunction

public PutMetadataFunction(ConfluenceWebResourceManager webResourceManager)

Method Details

getName

public String getName()

Specified by:

getName in interface com.atlassian.soy.renderer.SoyFunction

apply

public Boolean apply(Object... args)

Specified by:

apply in interface com.atlassian.soy.renderer.SoyServerFunction<Boolean>

Parameters:

args - two arguments expected, first a unique key to store the value against and second an HTML-safe string

validArgSizes

public Set<Integer> validArgSizes()

Specified by:

validArgSizes in interface com.atlassian.soy.renderer.SoyFunction