org.jboss.shrinkwrap.descriptor.api.facesuicomponent20
Interface WebFacesUIComponentDescriptor

All Superinterfaces:

Descriptor, DescriptorNamespace<WebFacesUIComponentDescriptor>

public interface WebFacesUIComponentDescriptor
extends Descriptor, DescriptorNamespace<WebFacesUIComponentDescriptor>

This deployment descriptor provides the functionalities as described in the specification

Example:

WebFacesUIComponentDescriptor descriptor = Descriptors.create(WebFacesUIComponentDescriptor.class);

Since:

Generation date :2012-05-09T23:45:03.702-07:00

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

WebFacesUIComponentDescriptor	_default(String _default) Sets the default attribute
WebFacesUIComponentDescriptor	applyTo(String applyTo) Sets the applyTo attribute
UicomponentAttributeType<WebFacesUIComponentDescriptor>	createAttribute() Creates a new attribute element
WebFacesUIComponentDescriptor	displayName(String displayName) Sets the displayName attribute
WebFacesUIComponentDescriptor	expert(Boolean expert) Sets the expert attribute
String	get_Default() Returns the default attribute
List<UicomponentAttributeType<WebFacesUIComponentDescriptor>>	getAllAttribute() Returns all attribute elements
String	getApplyTo() Returns the applyTo attribute
String	getDisplayName() Returns the displayName attribute
String	getMethodSignature() Returns the method-signature attribute
String	getName() Returns the name attribute
UicomponentAttributeType<WebFacesUIComponentDescriptor>	getOrCreateAttribute() If not already created, a new attribute element will be created and returned.
String	getShortDescription() Returns the shortDescription attribute
Boolean	isExpert() Returns the expert attribute
Boolean	isPreferred() Returns the preferred attribute
Boolean	isRequired() Returns the required attribute
WebFacesUIComponentDescriptor	methodSignature(String methodSignature) Sets the method-signature attribute
WebFacesUIComponentDescriptor	name(String name) Sets the name attribute
WebFacesUIComponentDescriptor	preferred(Boolean preferred) Sets the preferred attribute
WebFacesUIComponentDescriptor	remove_Default() Removes the default attribute
WebFacesUIComponentDescriptor	removeAllAttribute() Removes all attribute elements
WebFacesUIComponentDescriptor	removeApplyTo() Removes the applyTo attribute
WebFacesUIComponentDescriptor	removeDisplayName() Removes the displayName attribute
WebFacesUIComponentDescriptor	removeExpert() Removes the expert attribute
WebFacesUIComponentDescriptor	removeMethodSignature() Removes the method-signature attribute
WebFacesUIComponentDescriptor	removeName() Removes the name attribute
WebFacesUIComponentDescriptor	removePreferred() Removes the preferred attribute
WebFacesUIComponentDescriptor	removeRequired() Removes the required attribute
WebFacesUIComponentDescriptor	removeShortDescription() Removes the shortDescription attribute
WebFacesUIComponentDescriptor	required(Boolean required) Sets the required attribute
WebFacesUIComponentDescriptor	shortDescription(String shortDescription) Sets the shortDescription attribute

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

exportAsString, exportTo, getDescriptorName

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

addDefaultNamespaces, addNamespace, getNamespaces, removeAllNamespaces

Method Detail

getOrCreateAttribute

UicomponentAttributeType<WebFacesUIComponentDescriptor> getOrCreateAttribute()

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

Returns:

the instance defined for the element attribute

createAttribute

UicomponentAttributeType<WebFacesUIComponentDescriptor> createAttribute()

Creates a new attribute element

Returns:

the new created instance of UicomponentAttributeType

getAllAttribute

List<UicomponentAttributeType<WebFacesUIComponentDescriptor>> getAllAttribute()

Returns all attribute elements

Returns:

list of attribute

removeAllAttribute

WebFacesUIComponentDescriptor removeAllAttribute()

Removes all attribute elements

Returns:

the current instance of UicomponentAttributeType

name

WebFacesUIComponentDescriptor name(String name)

Sets the name attribute

Parameters:

name - the value for the attribute name

Returns:

the current instance of WebFacesUIComponentDescriptor

getName

String getName()

Returns the name attribute

Returns:

the value defined for the attribute name

removeName

WebFacesUIComponentDescriptor removeName()

Removes the name attribute

Returns:

the current instance of WebFacesUIComponentDescriptor

displayName

WebFacesUIComponentDescriptor displayName(String displayName)

Sets the displayName attribute

Parameters:

displayName - the value for the attribute displayName

Returns:

the current instance of WebFacesUIComponentDescriptor

getDisplayName

String getDisplayName()

Returns the displayName attribute

Returns:

the value defined for the attribute displayName

removeDisplayName

WebFacesUIComponentDescriptor removeDisplayName()

Removes the displayName attribute

Returns:

the current instance of WebFacesUIComponentDescriptor

shortDescription

WebFacesUIComponentDescriptor shortDescription(String shortDescription)

Sets the shortDescription attribute

Parameters:

shortDescription - the value for the attribute shortDescription

Returns:

the current instance of WebFacesUIComponentDescriptor

getShortDescription

String getShortDescription()

Returns the shortDescription attribute

Returns:

the value defined for the attribute shortDescription

removeShortDescription

WebFacesUIComponentDescriptor removeShortDescription()

Removes the shortDescription attribute

Returns:

the current instance of WebFacesUIComponentDescriptor

_default

WebFacesUIComponentDescriptor _default(String _default)

Sets the default attribute

Parameters:

_default - the value for the attribute default

Returns:

the current instance of WebFacesUIComponentDescriptor

get_Default

String get_Default()

Returns the default attribute

Returns:

the value defined for the attribute default

remove_Default

WebFacesUIComponentDescriptor remove_Default()

Removes the default attribute

Returns:

the current instance of WebFacesUIComponentDescriptor

methodSignature

WebFacesUIComponentDescriptor methodSignature(String methodSignature)

Sets the method-signature attribute

Parameters:

methodSignature - the value for the attribute method-signature

Returns:

the current instance of WebFacesUIComponentDescriptor

getMethodSignature

String getMethodSignature()

Returns the method-signature attribute

Returns:

the value defined for the attribute method-signature

removeMethodSignature

WebFacesUIComponentDescriptor removeMethodSignature()

Removes the method-signature attribute

Returns:

the current instance of WebFacesUIComponentDescriptor

applyTo

WebFacesUIComponentDescriptor applyTo(String applyTo)

Sets the applyTo attribute

Parameters:

applyTo - the value for the attribute applyTo

Returns:

the current instance of WebFacesUIComponentDescriptor

getApplyTo

String getApplyTo()

Returns the applyTo attribute

Returns:

the value defined for the attribute applyTo

removeApplyTo

WebFacesUIComponentDescriptor removeApplyTo()

Removes the applyTo attribute

Returns:

the current instance of WebFacesUIComponentDescriptor

required

WebFacesUIComponentDescriptor required(Boolean required)

Sets the required attribute

Parameters:

required - the value for the attribute required

Returns:

the current instance of WebFacesUIComponentDescriptor

isRequired

Boolean isRequired()

Returns the required attribute

Returns:

the value defined for the attribute required

removeRequired

WebFacesUIComponentDescriptor removeRequired()

Removes the required attribute

Returns:

the current instance of WebFacesUIComponentDescriptor

preferred

WebFacesUIComponentDescriptor preferred(Boolean preferred)

Sets the preferred attribute

Parameters:

preferred - the value for the attribute preferred

Returns:

the current instance of WebFacesUIComponentDescriptor

isPreferred

Boolean isPreferred()

Returns the preferred attribute

Returns:

the value defined for the attribute preferred

removePreferred

WebFacesUIComponentDescriptor removePreferred()

Removes the preferred attribute

Returns:

the current instance of WebFacesUIComponentDescriptor

expert

WebFacesUIComponentDescriptor expert(Boolean expert)

Sets the expert attribute

Parameters:

expert - the value for the attribute expert

Returns:

the current instance of WebFacesUIComponentDescriptor

isExpert

Boolean isExpert()

Returns the expert attribute

Returns:

the value defined for the attribute expert

removeExpert

WebFacesUIComponentDescriptor removeExpert()

Removes the expert attribute

Returns:

the current instance of WebFacesUIComponentDescriptor