Package com.atlassian.jira.soy

Class AbstractHelpFunction

java.lang.Object

com.atlassian.jira.soy.AbstractHelpFunction

All Implemented Interfaces:

com.atlassian.soy.renderer.SoyClientFunction, com.atlassian.soy.renderer.SoyFunction, com.atlassian.soy.renderer.SoyServerFunction<String>

Direct Known Subclasses:

HelpDescriptionFunction, HelpTitleFunction, HelpUrlFunction

public abstract class AbstractHelpFunction
extends Object
implements com.atlassian.soy.renderer.SoyServerFunction<String>, com.atlassian.soy.renderer.SoyClientFunction

Abstract Soy function that returns help information for a given key.

Since:

v7.0

Constructor Summary

Constructors

Constructor	Description
AbstractHelpFunction(HelpUrls helpUrls)

Method Summary

Modifier and Type	Method	Description
String	apply(Object... args)
com.atlassian.soy.renderer.JsExpression	generate(com.atlassian.soy.renderer.JsExpression... args)
Set<Integer>	validArgSizes()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.soy.renderer.SoyFunction

getName

Constructor Details

AbstractHelpFunction

public AbstractHelpFunction(HelpUrls helpUrls)

Method Details

generate

public com.atlassian.soy.renderer.JsExpression generate(com.atlassian.soy.renderer.JsExpression... args)

Specified by:

generate in interface com.atlassian.soy.renderer.SoyClientFunction

apply

public String apply(Object... args)

Specified by:

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

validArgSizes

public Set<Integer> validArgSizes()

Specified by:

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