net.sourceforge.ccxjc.it.model.priv.indexed.novalueclass.javaee
Interface FunctionType

All Known Implementing Classes:

FunctionTypeImpl

public interface FunctionType

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

Java class for functionType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="functionType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <group ref="{http://java.sun.com/xml/ns/javaee}descriptionGroup"/>
         <element name="name" type="{http://java.sun.com/xml/ns/javaee}tld-canonical-nameType"/>
         <element name="function-class" type="{http://java.sun.com/xml/ns/javaee}fully-qualified-classType"/>
         <element name="function-signature" type="{http://java.sun.com/xml/ns/javaee}string"/>
         <element name="example" type="{http://java.sun.com/xml/ns/javaee}xsdStringType" minOccurs="0"/>
         <element name="function-extension" type="{http://java.sun.com/xml/ns/javaee}tld-extensionType" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </restriction>
   </complexContent>
 </complexType>
 

Method Summary

DescriptionType[]	getDescription()
DescriptionType	getDescription(int idx)
int	getDescriptionLength()
DisplayNameType[]	getDisplayName()
DisplayNameType	getDisplayName(int idx)
int	getDisplayNameLength()
XsdStringType	getExample() Gets the value of the example property.
FullyQualifiedClassType	getFunctionClass() Gets the value of the functionClass property.
TldExtensionType[]	getFunctionExtension()
TldExtensionType	getFunctionExtension(int idx)
int	getFunctionExtensionLength()
String	getFunctionSignature() Gets the value of the functionSignature property.
IconType[]	getIcon()
IconType	getIcon(int idx)
int	getIconLength()
String	getId() Gets the value of the id property.
TldCanonicalNameType	getName() Gets the value of the name property.
void	setDescription(DescriptionType[] values)
DescriptionType	setDescription(int idx, DescriptionType value)
void	setDisplayName(DisplayNameType[] values)
DisplayNameType	setDisplayName(int idx, DisplayNameType value)
void	setExample(XsdStringType value) Sets the value of the example property.
void	setFunctionClass(FullyQualifiedClassType value) Sets the value of the functionClass property.
TldExtensionType	setFunctionExtension(int idx, TldExtensionType value)
void	setFunctionExtension(TldExtensionType[] values)
void	setFunctionSignature(String value) Sets the value of the functionSignature property.
void	setIcon(IconType[] values)
IconType	setIcon(int idx, IconType value)
void	setId(String value) Sets the value of the id property.
void	setName(TldCanonicalNameType value) Sets the value of the name property.

Method Detail

getDescription

DescriptionType[] getDescription()

Returns:

array of DescriptionType

getDescription

DescriptionType getDescription(int idx)

Returns:

one of DescriptionType

getDescriptionLength

int getDescriptionLength()

setDescription

void setDescription(DescriptionType[] values)

Parameters:

values - allowed objects are DescriptionType

setDescription

DescriptionType setDescription(int idx,
                               DescriptionType value)

Parameters:

value - allowed object is DescriptionType

getDisplayName

DisplayNameType[] getDisplayName()

Returns:

array of DisplayNameType

getDisplayName

DisplayNameType getDisplayName(int idx)

Returns:

one of DisplayNameType

getDisplayNameLength

int getDisplayNameLength()

setDisplayName

void setDisplayName(DisplayNameType[] values)

Parameters:

values - allowed objects are DisplayNameType

setDisplayName

DisplayNameType setDisplayName(int idx,
                               DisplayNameType value)

Parameters:

value - allowed object is DisplayNameType

getIcon

IconType[] getIcon()

Returns:

array of IconType

getIcon

IconType getIcon(int idx)

Returns:

one of IconType

getIconLength

int getIconLength()

setIcon

void setIcon(IconType[] values)

Parameters:

values - allowed objects are IconType

setIcon

IconType setIcon(int idx,
                 IconType value)

Parameters:

value - allowed object is IconType

getName

TldCanonicalNameType getName()

Gets the value of the name property.

Returns:

possible object is TldCanonicalNameType

setName

void setName(TldCanonicalNameType value)

Sets the value of the name property.

Parameters:

value - allowed object is TldCanonicalNameType

getFunctionClass

FullyQualifiedClassType getFunctionClass()

Gets the value of the functionClass property.

Returns:

possible object is FullyQualifiedClassType

setFunctionClass

void setFunctionClass(FullyQualifiedClassType value)

Sets the value of the functionClass property.

Parameters:

value - allowed object is FullyQualifiedClassType

getFunctionSignature

String getFunctionSignature()

Gets the value of the functionSignature property.

Returns:

possible object is String

setFunctionSignature

void setFunctionSignature(String value)

Sets the value of the functionSignature property.

Parameters:

value - allowed object is String

getExample

XsdStringType getExample()

Gets the value of the example property.

Returns:

possible object is XsdStringType

setExample

void setExample(XsdStringType value)

Sets the value of the example property.

Parameters:

value - allowed object is XsdStringType

getFunctionExtension

TldExtensionType[] getFunctionExtension()

Returns:

array of TldExtensionType

getFunctionExtension

TldExtensionType getFunctionExtension(int idx)

Returns:

one of TldExtensionType

getFunctionExtensionLength

int getFunctionExtensionLength()

setFunctionExtension

void setFunctionExtension(TldExtensionType[] values)

Parameters:

values - allowed objects are TldExtensionType

setFunctionExtension

TldExtensionType setFunctionExtension(int idx,
                                      TldExtensionType value)

Parameters:

value - allowed object is TldExtensionType

getId

String getId()

Gets the value of the id property.

Returns:

possible object is String

setId

void setId(String value)

Sets the value of the id property.

Parameters:

value - allowed object is String