net.sourceforge.ccxjc.it.model.prot.collections.valueclass.javaee
Class FunctionType

java.lang.Object
  extended by net.sourceforge.ccxjc.it.model.prot.collections.valueclass.javaee.FunctionType
All Implemented Interfaces:
Serializable, Cloneable

public class FunctionType
extends Object
implements Serializable, Cloneable

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>
 

See Also:
Serialized Form

Field Summary
protected  List<DescriptionType> description
           
protected  List<DisplayNameType> displayName
           
protected  XsdStringType example
           
protected  FullyQualifiedClassType functionClass
           
protected  List<TldExtensionType> functionExtension
           
protected  String functionSignature
           
protected  List<IconType> icon
           
protected  String id
           
protected  TldCanonicalNameType name
           
 
Constructor Summary
FunctionType()
          Creates a new net.sourceforge.ccxjc.it.model.prot.collections.valueclass.javaee.FunctionType instance.
FunctionType(FunctionType o)
          Creates a new net.sourceforge.ccxjc.it.model.prot.collections.valueclass.javaee.FunctionType instance by copying a given instance.
 
Method Summary
 FunctionType clone()
          Creates and returns a copy of this object.
protected static void copyDescription(List<DescriptionType> source, List<DescriptionType> target)
          Copies all values of property Description.
protected static void copyDisplayName(List<DisplayNameType> source, List<DisplayNameType> target)
          Copies all values of property DisplayName.
protected static void copyFunctionExtension(List<TldExtensionType> source, List<TldExtensionType> target)
          Copies all values of property FunctionExtension.
protected static void copyIcon(List<IconType> source, List<IconType> target)
          Copies all values of property Icon.
 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.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

description

protected List<DescriptionType> description

displayName

protected List<DisplayNameType> displayName

icon

protected List<IconType> icon

name

protected TldCanonicalNameType name

functionClass

protected FullyQualifiedClassType functionClass

functionSignature

protected String functionSignature

example

protected XsdStringType example

functionExtension

protected List<TldExtensionType> functionExtension

id

protected String id
Constructor Detail

FunctionType

public FunctionType()
Creates a new net.sourceforge.ccxjc.it.model.prot.collections.valueclass.javaee.FunctionType instance.


FunctionType

public FunctionType(FunctionType o)
Creates a new net.sourceforge.ccxjc.it.model.prot.collections.valueclass.javaee.FunctionType instance by copying a given instance.

Parameters:
o - The instance to copy or null.
Method Detail

getDescription

public 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

public 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

public 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

public TldCanonicalNameType getName()
Gets the value of the name property.

Returns:
possible object is TldCanonicalNameType

setName

public void setName(TldCanonicalNameType value)
Sets the value of the name property.

Parameters:
value - allowed object is TldCanonicalNameType

getFunctionClass

public FullyQualifiedClassType getFunctionClass()
Gets the value of the functionClass property.

Returns:
possible object is FullyQualifiedClassType

setFunctionClass

public void setFunctionClass(FullyQualifiedClassType value)
Sets the value of the functionClass property.

Parameters:
value - allowed object is FullyQualifiedClassType

getFunctionSignature

public String getFunctionSignature()
Gets the value of the functionSignature property.

Returns:
possible object is String

setFunctionSignature

public void setFunctionSignature(String value)
Sets the value of the functionSignature property.

Parameters:
value - allowed object is String

getExample

public XsdStringType getExample()
Gets the value of the example property.

Returns:
possible object is XsdStringType

setExample

public void setExample(XsdStringType value)
Sets the value of the example property.

Parameters:
value - allowed object is XsdStringType

getFunctionExtension

public 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

public String getId()
Gets the value of the id property.

Returns:
possible object is String

setId

public void setId(String value)
Sets the value of the id property.

Parameters:
value - allowed object is String

copyDescription

protected static void copyDescription(List<DescriptionType> source,
                                      List<DescriptionType> target)
Copies all values of property Description.

Parameters:
target - The target to copy source to.
source - The source to copy from.
Throws:
NullPointerException - if source or target is null.

copyDisplayName

protected static void copyDisplayName(List<DisplayNameType> source,
                                      List<DisplayNameType> target)
Copies all values of property DisplayName.

Parameters:
target - The target to copy source to.
source - The source to copy from.
Throws:
NullPointerException - if source or target is null.

copyIcon

protected static void copyIcon(List<IconType> source,
                               List<IconType> target)
Copies all values of property Icon.

Parameters:
target - The target to copy source to.
source - The source to copy from.
Throws:
NullPointerException - if source or target is null.

copyFunctionExtension

protected static void copyFunctionExtension(List<TldExtensionType> source,
                                            List<TldExtensionType> target)
Copies all values of property FunctionExtension.

Parameters:
target - The target to copy source to.
source - The source to copy from.
Throws:
NullPointerException - if source or target is null.

clone

public FunctionType clone()
Creates and returns a copy of this object.

Overrides:
clone in class Object
Returns:
A clone of this instance.


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