org.apache.openejb.jee
Class Function

java.lang.Object
  extended by org.apache.openejb.jee.Function

public class Function
extends Object

The function element is used to provide information on each function in the tag library that is to be exposed to the EL.

The function element may have several subelements defining:

description Optional tag-specific information

display-name A short name that is intended to be displayed by tools

icon Optional icon element that can be used by tools

name A unique name for this function

function-class Provides the name of the Java class that implements the function

function-signature Provides the signature, as in the Java Language Specification, of the Java method that is to be used to implement the function.

example Optional informal description of an example of a use of this function

function-extension Zero or more extensions that provide extra information about this function, for tool consumption


Field Summary
protected  TextMap description
           
protected  TextMap displayName
           
protected  String example
           
protected  String functionClass
           
protected  List<TldExtension> functionExtension
           
protected  String functionSignature
           
protected  LocalCollection<Icon> icon
           
protected  String id
           
protected  String name
           
 
Constructor Summary
Function()
           
 
Method Summary
 String getDescription()
           
 Text[] getDescriptions()
           
 String getDisplayName()
           
 Text[] getDisplayNames()
           
 String getExample()
           
 String getFunctionClass()
           
 List<TldExtension> getFunctionExtension()
           
 String getFunctionSignature()
           
 Icon getIcon()
           
 Map<String,Icon> getIconMap()
           
 Collection<Icon> getIcons()
           
 String getId()
           
 String getName()
           
 void setDescriptions(Text[] text)
           
 void setDisplayNames(Text[] text)
           
 void setExample(String value)
           
 void setFunctionClass(String value)
           
 void setFunctionSignature(String value)
           
 void setId(String value)
           
 void setName(String value)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

description

protected TextMap description

displayName

protected TextMap displayName

icon

protected LocalCollection<Icon> icon

name

protected String name

functionClass

protected String functionClass

functionSignature

protected String functionSignature

example

protected String example

functionExtension

protected List<TldExtension> functionExtension

id

protected String id
Constructor Detail

Function

public Function()
Method Detail

getDescriptions

public Text[] getDescriptions()

setDescriptions

public void setDescriptions(Text[] text)

getDescription

public String getDescription()

getDisplayNames

public Text[] getDisplayNames()

setDisplayNames

public void setDisplayNames(Text[] text)

getDisplayName

public String getDisplayName()

getIcons

public Collection<Icon> getIcons()

getIconMap

public Map<String,Icon> getIconMap()

getIcon

public Icon getIcon()

getName

public String getName()

setName

public void setName(String value)

getFunctionClass

public String getFunctionClass()

setFunctionClass

public void setFunctionClass(String value)

getFunctionSignature

public String getFunctionSignature()

setFunctionSignature

public void setFunctionSignature(String value)

getExample

public String getExample()

setExample

public void setExample(String value)

getFunctionExtension

public List<TldExtension> getFunctionExtension()

getId

public String getId()

setId

public void setId(String value)


Copyright © 1999-2013 The Apache OpenEJB development community. All Rights Reserved.