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

java.lang.Object
  net.sourceforge.ccxjc.it.model.prot.indexed.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 DescriptionType[]	description
protected DisplayNameType[]	displayName
protected XsdStringType	example
protected FullyQualifiedClassType	functionClass
protected TldExtensionType[]	functionExtension
protected String	functionSignature
protected IconType[]	icon
protected String	id
protected TldCanonicalNameType	name

Constructor Summary

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

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

Method Summary

FunctionType	clone() Creates and returns a copy of this object.
protected void	copyDescription(DescriptionType[] source) Copies all values of property Description.
protected void	copyDisplayName(DisplayNameType[] source) Copies all values of property DisplayName.
protected void	copyFunctionExtension(TldExtensionType[] source) Copies all values of property FunctionExtension.
protected void	copyIcon(IconType[] source) Copies all values of property Icon.
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.

Methods inherited from class java.lang.Object

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

Field Detail

description

protected DescriptionType[] description

displayName

protected DisplayNameType[] displayName

icon

protected IconType[] icon

name

protected TldCanonicalNameType name

functionClass

protected FullyQualifiedClassType functionClass

functionSignature

protected String functionSignature

example

protected XsdStringType example

functionExtension

protected TldExtensionType[] functionExtension

id

protected String id

Constructor Detail

FunctionType

public FunctionType()

Creates a new net.sourceforge.ccxjc.it.model.prot.indexed.valueclass.javaee.FunctionType instance.

FunctionType

public FunctionType(FunctionType o)

Creates a new net.sourceforge.ccxjc.it.model.prot.indexed.valueclass.javaee.FunctionType instance by copying a given instance.

Parameters:

o - The instance to copy or null.

Method Detail

getDescription

public DescriptionType[] getDescription()

Returns:

array of DescriptionType

getDescription

public DescriptionType getDescription(int idx)

Returns:

one of DescriptionType

getDescriptionLength

public int getDescriptionLength()

setDescription

public void setDescription(DescriptionType[] values)

Parameters:

values - allowed objects are DescriptionType

setDescription

public DescriptionType setDescription(int idx,
                                      DescriptionType value)

Parameters:

value - allowed object is DescriptionType

getDisplayName

public DisplayNameType[] getDisplayName()

Returns:

array of DisplayNameType

getDisplayName

public DisplayNameType getDisplayName(int idx)

Returns:

one of DisplayNameType

getDisplayNameLength

public int getDisplayNameLength()

setDisplayName

public void setDisplayName(DisplayNameType[] values)

Parameters:

values - allowed objects are DisplayNameType

setDisplayName

public DisplayNameType setDisplayName(int idx,
                                      DisplayNameType value)

Parameters:

value - allowed object is DisplayNameType

getIcon

public IconType[] getIcon()

Returns:

array of IconType

getIcon

public IconType getIcon(int idx)

Returns:

one of IconType

getIconLength

public int getIconLength()

setIcon

public void setIcon(IconType[] values)

Parameters:

values - allowed objects are IconType

setIcon

public IconType setIcon(int idx,
                        IconType value)

Parameters:

value - allowed object is 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 TldExtensionType[] getFunctionExtension()

Returns:

array of TldExtensionType

getFunctionExtension

public TldExtensionType getFunctionExtension(int idx)

Returns:

one of TldExtensionType

getFunctionExtensionLength

public int getFunctionExtensionLength()

setFunctionExtension

public void setFunctionExtension(TldExtensionType[] values)

Parameters:

values - allowed objects are TldExtensionType

setFunctionExtension

public TldExtensionType setFunctionExtension(int idx,
                                             TldExtensionType value)

Parameters:

value - allowed object is 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 void copyDescription(DescriptionType[] source)

Copies all values of property Description.

Parameters:

source - The source to copy from.

Throws:

NullPointerException - if source is null.

copyDisplayName

protected void copyDisplayName(DisplayNameType[] source)

Copies all values of property DisplayName.

Parameters:

source - The source to copy from.

Throws:

NullPointerException - if source is null.

copyIcon

protected void copyIcon(IconType[] source)

Copies all values of property Icon.

Parameters:

source - The source to copy from.

Throws:

NullPointerException - if source is null.

copyFunctionExtension

protected void copyFunctionExtension(TldExtensionType[] source)

Copies all values of property FunctionExtension.

Parameters:

source - The source to copy from.

Throws:

NullPointerException - if source 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.