org.jboss.shrinkwrap.descriptor.api.facelettaglibrary20

Interface FaceletTaglibFunctionType<T>

All Superinterfaces:

Child<T>, JavaeeFaceletTaglibFunctionCommonType<T,FaceletTaglibFunctionType<T>>

public interface FaceletTaglibFunctionType<T>
extends Child<T>, JavaeeFaceletTaglibFunctionCommonType<T,FaceletTaglibFunctionType<T>>

This interface defines the contract for the facelet-taglib-functionType xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger, George Gastaldi

Method Summary

Modifier and Type	Method and Description
IconType<FaceletTaglibFunctionType<T>>	createIcon() Creates a new icon element
FaceletTaglibFunctionType<T>	description(String... values) Creates for all String objects representing description elements, a new description element
FaceletTaglibFunctionType<T>	displayName(String... values) Creates for all String objects representing display-name elements, a new display-name element
FaceletTaglibFunctionType<T>	functionClass(String functionClass) Sets the function-class element
FaceletTaglibFunctionType<T>	functionName(String functionName) Sets the function-name element
FaceletTaglibFunctionType<T>	functionSignature(String functionSignature) Sets the function-signature element
List<String>	getAllDescription() Returns all description elements
List<String>	getAllDisplayName() Returns all display-name elements
List<IconType<FaceletTaglibFunctionType<T>>>	getAllIcon() Returns all icon elements
String	getFunctionClass() Returns the function-class element
String	getFunctionName() Returns the function-name element
String	getFunctionSignature() Returns the function-signature element
IconType<FaceletTaglibFunctionType<T>>	getOrCreateIcon() If not already created, a new icon element will be created and returned.
FaceletTaglibFunctionType<T>	removeAllDescription() Removes the description element
FaceletTaglibFunctionType<T>	removeAllDisplayName() Removes the display-name element
FaceletTaglibFunctionType<T>	removeAllIcon() Removes all icon elements
FaceletTaglibFunctionType<T>	removeFunctionClass() Removes the function-class element
FaceletTaglibFunctionType<T>	removeFunctionName() Removes the function-name element
FaceletTaglibFunctionType<T>	removeFunctionSignature() Removes the function-signature element

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child

up

Method Detail

description

FaceletTaglibFunctionType<T> description(String... values)

Creates for all String objects representing description elements, a new description element

Parameters:

values - list of description objects

Returns:

the current instance of FaceletTaglibFunctionType

getAllDescription

List<String> getAllDescription()

Returns all description elements

Returns:

list of description

removeAllDescription

FaceletTaglibFunctionType<T> removeAllDescription()

Removes the description element

Returns:

the current instance of FaceletTaglibFunctionType

displayName

FaceletTaglibFunctionType<T> displayName(String... values)

Creates for all String objects representing display-name elements, a new display-name element

Parameters:

values - list of display-name objects

Returns:

the current instance of FaceletTaglibFunctionType

getAllDisplayName

List<String> getAllDisplayName()

Returns all display-name elements

Returns:

list of display-name

removeAllDisplayName

FaceletTaglibFunctionType<T> removeAllDisplayName()

Removes the display-name element

Returns:

the current instance of FaceletTaglibFunctionType

getOrCreateIcon

IconType<FaceletTaglibFunctionType<T>> getOrCreateIcon()

If not already created, a new icon element will be created and returned. Otherwise, the first existing icon element will be returned.

Returns:

the instance defined for the element icon

createIcon

IconType<FaceletTaglibFunctionType<T>> createIcon()

Creates a new icon element

Returns:

the new created instance of IconType>

getAllIcon

List<IconType<FaceletTaglibFunctionType<T>>> getAllIcon()

Returns all icon elements

Returns:

list of icon

removeAllIcon

FaceletTaglibFunctionType<T> removeAllIcon()

Removes all icon elements

Returns:

the current instance of IconType>

functionName

FaceletTaglibFunctionType<T> functionName(String functionName)

Sets the function-name element

Parameters:

functionName - the value for the element function-name

Returns:

the current instance of FaceletTaglibFunctionType

getFunctionName

String getFunctionName()

Returns the function-name element

Returns:

the node defined for the element function-name

removeFunctionName

FaceletTaglibFunctionType<T> removeFunctionName()

Removes the function-name element

Returns:

the current instance of FaceletTaglibFunctionType

functionClass

FaceletTaglibFunctionType<T> functionClass(String functionClass)

Sets the function-class element

Parameters:

functionClass - the value for the element function-class

Returns:

the current instance of FaceletTaglibFunctionType

getFunctionClass

String getFunctionClass()

Returns the function-class element

Returns:

the node defined for the element function-class

removeFunctionClass

FaceletTaglibFunctionType<T> removeFunctionClass()

Removes the function-class element

Returns:

the current instance of FaceletTaglibFunctionType

functionSignature

FaceletTaglibFunctionType<T> functionSignature(String functionSignature)

Sets the function-signature element

Parameters:

functionSignature - the value for the element function-signature

Returns:

the current instance of FaceletTaglibFunctionType

getFunctionSignature

String getFunctionSignature()

Returns the function-signature element

Returns:

the node defined for the element function-signature

removeFunctionSignature

FaceletTaglibFunctionType<T> removeFunctionSignature()

Removes the function-signature element

Returns:

the current instance of FaceletTaglibFunctionType