net.sourceforge.ccxjc.it.model.priv.collections.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
 List<DescriptionType> getDescription()
          Gets the value of the description property.
 List<DisplayNameType> getDisplayName()
          Gets the value of the displayName property.
 XsdStringType getExample()
          Gets the value of the example property.
 FullyQualifiedClassType getFunctionClass()
          Gets the value of the functionClass property.
 List<TldExtensionType> getFunctionExtension()
          Gets the value of the functionExtension property.
 String getFunctionSignature()
          Gets the value of the functionSignature property.
 List<IconType> getIcon()
          Gets the value of the icon property.
 String getId()
          Gets the value of the id property.
 TldCanonicalNameType getName()
          Gets the value of the name property.
 void setExample(XsdStringType value)
          Sets the value of the example property.
 void setFunctionClass(FullyQualifiedClassType value)
          Sets the value of the functionClass property.
 void setFunctionSignature(String value)
          Sets the value of the functionSignature property.
 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

List<DescriptionType> getDescription()
Gets the value of the description property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the description property.

For example, to add a new item, do as follows:

    getDescription().add(newItem);
 

Objects of the following type(s) are allowed in the list DescriptionType


getDisplayName

List<DisplayNameType> getDisplayName()
Gets the value of the displayName property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the displayName property.

For example, to add a new item, do as follows:

    getDisplayName().add(newItem);
 

Objects of the following type(s) are allowed in the list DisplayNameType


getIcon

List<IconType> getIcon()
Gets the value of the icon property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the icon property.

For example, to add a new item, do as follows:

    getIcon().add(newItem);
 

Objects of the following type(s) are allowed in the list 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

List<TldExtensionType> getFunctionExtension()
Gets the value of the functionExtension property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the functionExtension property.

For example, to add a new item, do as follows:

    getFunctionExtension().add(newItem);
 

Objects of the following type(s) are allowed in the list 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


Copyright © 2009 The CC-XJC Community. All Rights Reserved.