org.jboss.shrinkwrap.descriptor.api.facesconfig20
Interface WebFacesConfigDescriptor

All Superinterfaces:

Descriptor, DescriptorNamespace<WebFacesConfigDescriptor>

public interface WebFacesConfigDescriptor
extends Descriptor, DescriptorNamespace<WebFacesConfigDescriptor>

This deployment descriptor provides the functionalities as described in the specification

Example:

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

Since:

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

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

FacesConfigAbsoluteOrderingType<WebFacesConfigDescriptor>	createAbsoluteOrdering() Creates a new absolute-ordering element
FacesConfigApplicationType<WebFacesConfigDescriptor>	createApplication() Creates a new application element
FacesConfigBehaviorType<WebFacesConfigDescriptor>	createBehavior() Creates a new behavior element
FacesConfigComponentType<WebFacesConfigDescriptor>	createComponent() Creates a new component element
FacesConfigConverterType<WebFacesConfigDescriptor>	createConverter() Creates a new converter element
FacesConfigFactoryType<WebFacesConfigDescriptor>	createFactory() Creates a new factory element
FacesConfigLifecycleType<WebFacesConfigDescriptor>	createLifecycle() Creates a new lifecycle element
FacesConfigManagedBeanType<WebFacesConfigDescriptor>	createManagedBean() Creates a new managed-bean element
FacesConfigNavigationRuleType<WebFacesConfigDescriptor>	createNavigationRule() Creates a new navigation-rule element
FacesConfigOrderingType<WebFacesConfigDescriptor>	createOrdering() Creates a new ordering element
FacesConfigReferencedBeanType<WebFacesConfigDescriptor>	createReferencedBean() Creates a new referenced-bean element
FacesConfigRenderKitType<WebFacesConfigDescriptor>	createRenderKit() Creates a new render-kit element
FacesConfigValidatorType<WebFacesConfigDescriptor>	createValidator() Creates a new validator element
WebFacesConfigDescriptor	facesConfigExtension() Sets the faces-config-extension element
List<FacesConfigAbsoluteOrderingType<WebFacesConfigDescriptor>>	getAllAbsoluteOrdering() Returns all absolute-ordering elements
List<FacesConfigApplicationType<WebFacesConfigDescriptor>>	getAllApplication() Returns all application elements
List<FacesConfigBehaviorType<WebFacesConfigDescriptor>>	getAllBehavior() Returns all behavior elements
List<FacesConfigComponentType<WebFacesConfigDescriptor>>	getAllComponent() Returns all component elements
List<FacesConfigConverterType<WebFacesConfigDescriptor>>	getAllConverter() Returns all converter elements
List<FacesConfigFactoryType<WebFacesConfigDescriptor>>	getAllFactory() Returns all factory elements
List<FacesConfigLifecycleType<WebFacesConfigDescriptor>>	getAllLifecycle() Returns all lifecycle elements
List<FacesConfigManagedBeanType<WebFacesConfigDescriptor>>	getAllManagedBean() Returns all managed-bean elements
List<String>	getAllName() Returns all name elements
List<FacesConfigNavigationRuleType<WebFacesConfigDescriptor>>	getAllNavigationRule() Returns all navigation-rule elements
List<FacesConfigOrderingType<WebFacesConfigDescriptor>>	getAllOrdering() Returns all ordering elements
List<FacesConfigReferencedBeanType<WebFacesConfigDescriptor>>	getAllReferencedBean() Returns all referenced-bean elements
List<FacesConfigRenderKitType<WebFacesConfigDescriptor>>	getAllRenderKit() Returns all render-kit elements
List<FacesConfigValidatorType<WebFacesConfigDescriptor>>	getAllValidator() Returns all validator elements
FacesConfigAbsoluteOrderingType<WebFacesConfigDescriptor>	getOrCreateAbsoluteOrdering() If not already created, a new absolute-ordering element will be created and returned.
FacesConfigApplicationType<WebFacesConfigDescriptor>	getOrCreateApplication() If not already created, a new application element will be created and returned.
FacesConfigBehaviorType<WebFacesConfigDescriptor>	getOrCreateBehavior() If not already created, a new behavior element will be created and returned.
FacesConfigComponentType<WebFacesConfigDescriptor>	getOrCreateComponent() If not already created, a new component element will be created and returned.
FacesConfigConverterType<WebFacesConfigDescriptor>	getOrCreateConverter() If not already created, a new converter element will be created and returned.
FacesConfigFactoryType<WebFacesConfigDescriptor>	getOrCreateFactory() If not already created, a new factory element will be created and returned.
FacesConfigLifecycleType<WebFacesConfigDescriptor>	getOrCreateLifecycle() If not already created, a new lifecycle element will be created and returned.
FacesConfigManagedBeanType<WebFacesConfigDescriptor>	getOrCreateManagedBean() If not already created, a new managed-bean element will be created and returned.
FacesConfigNavigationRuleType<WebFacesConfigDescriptor>	getOrCreateNavigationRule() If not already created, a new navigation-rule element will be created and returned.
FacesConfigOrderingType<WebFacesConfigDescriptor>	getOrCreateOrdering() If not already created, a new ordering element will be created and returned.
FacesConfigReferencedBeanType<WebFacesConfigDescriptor>	getOrCreateReferencedBean() If not already created, a new referenced-bean element will be created and returned.
FacesConfigRenderKitType<WebFacesConfigDescriptor>	getOrCreateRenderKit() If not already created, a new render-kit element will be created and returned.
FacesConfigValidatorType<WebFacesConfigDescriptor>	getOrCreateValidator() If not already created, a new validator element will be created and returned.
FacesConfigVersionType	getVersion() Returns the version attribute
String	getVersionAsString() Returns the version attribute
Boolean	isFacesConfigExtension() Removes the faces-config-extension element
Boolean	isMetadataComplete() Returns the metadata-complete attribute
WebFacesConfigDescriptor	metadataComplete(Boolean metadataComplete) Sets the metadata-complete attribute
WebFacesConfigDescriptor	name(String... values) Creates for all String objects representing name elements, a new name element
WebFacesConfigDescriptor	removeAllAbsoluteOrdering() Removes all absolute-ordering elements
WebFacesConfigDescriptor	removeAllApplication() Removes all application elements
WebFacesConfigDescriptor	removeAllBehavior() Removes all behavior elements
WebFacesConfigDescriptor	removeAllComponent() Removes all component elements
WebFacesConfigDescriptor	removeAllConverter() Removes all converter elements
WebFacesConfigDescriptor	removeAllFactory() Removes all factory elements
WebFacesConfigDescriptor	removeAllLifecycle() Removes all lifecycle elements
WebFacesConfigDescriptor	removeAllManagedBean() Removes all managed-bean elements
WebFacesConfigDescriptor	removeAllName() Removes the name element
WebFacesConfigDescriptor	removeAllNavigationRule() Removes all navigation-rule elements
WebFacesConfigDescriptor	removeAllOrdering() Removes all ordering elements
WebFacesConfigDescriptor	removeAllReferencedBean() Removes all referenced-bean elements
WebFacesConfigDescriptor	removeAllRenderKit() Removes all render-kit elements
WebFacesConfigDescriptor	removeAllValidator() Removes all validator elements
WebFacesConfigDescriptor	removeFacesConfigExtension() Removes the faces-config-extension element
WebFacesConfigDescriptor	removeMetadataComplete() Removes the metadata-complete attribute
WebFacesConfigDescriptor	removeVersion() Removes the version attribute
WebFacesConfigDescriptor	version(FacesConfigVersionType version) Sets the version attribute
WebFacesConfigDescriptor	version(String version) Sets the version 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

getOrCreateApplication

FacesConfigApplicationType<WebFacesConfigDescriptor> getOrCreateApplication()

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

Returns:

the instance defined for the element application

createApplication

FacesConfigApplicationType<WebFacesConfigDescriptor> createApplication()

Creates a new application element

Returns:

the new created instance of FacesConfigApplicationType

getAllApplication

List<FacesConfigApplicationType<WebFacesConfigDescriptor>> getAllApplication()

Returns all application elements

Returns:

list of application

removeAllApplication

WebFacesConfigDescriptor removeAllApplication()

Removes all application elements

Returns:

the current instance of FacesConfigApplicationType

getOrCreateOrdering

FacesConfigOrderingType<WebFacesConfigDescriptor> getOrCreateOrdering()

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

Returns:

the instance defined for the element ordering

createOrdering

FacesConfigOrderingType<WebFacesConfigDescriptor> createOrdering()

Creates a new ordering element

Returns:

the new created instance of FacesConfigOrderingType

getAllOrdering

List<FacesConfigOrderingType<WebFacesConfigDescriptor>> getAllOrdering()

Returns all ordering elements

Returns:

list of ordering

removeAllOrdering

WebFacesConfigDescriptor removeAllOrdering()

Removes all ordering elements

Returns:

the current instance of FacesConfigOrderingType

getOrCreateAbsoluteOrdering

FacesConfigAbsoluteOrderingType<WebFacesConfigDescriptor> getOrCreateAbsoluteOrdering()

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

Returns:

the instance defined for the element absolute-ordering

createAbsoluteOrdering

FacesConfigAbsoluteOrderingType<WebFacesConfigDescriptor> createAbsoluteOrdering()

Creates a new absolute-ordering element

Returns:

the new created instance of FacesConfigAbsoluteOrderingType

getAllAbsoluteOrdering

List<FacesConfigAbsoluteOrderingType<WebFacesConfigDescriptor>> getAllAbsoluteOrdering()

Returns all absolute-ordering elements

Returns:

list of absolute-ordering

removeAllAbsoluteOrdering

WebFacesConfigDescriptor removeAllAbsoluteOrdering()

Removes all absolute-ordering elements

Returns:

the current instance of FacesConfigAbsoluteOrderingType

getOrCreateFactory

FacesConfigFactoryType<WebFacesConfigDescriptor> getOrCreateFactory()

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

Returns:

the instance defined for the element factory

createFactory

FacesConfigFactoryType<WebFacesConfigDescriptor> createFactory()

Creates a new factory element

Returns:

the new created instance of FacesConfigFactoryType

getAllFactory

List<FacesConfigFactoryType<WebFacesConfigDescriptor>> getAllFactory()

Returns all factory elements

Returns:

list of factory

removeAllFactory

WebFacesConfigDescriptor removeAllFactory()

Removes all factory elements

Returns:

the current instance of FacesConfigFactoryType

getOrCreateComponent

FacesConfigComponentType<WebFacesConfigDescriptor> getOrCreateComponent()

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

Returns:

the instance defined for the element component

createComponent

FacesConfigComponentType<WebFacesConfigDescriptor> createComponent()

Creates a new component element

Returns:

the new created instance of FacesConfigComponentType

getAllComponent

List<FacesConfigComponentType<WebFacesConfigDescriptor>> getAllComponent()

Returns all component elements

Returns:

list of component

removeAllComponent

WebFacesConfigDescriptor removeAllComponent()

Removes all component elements

Returns:

the current instance of FacesConfigComponentType

getOrCreateConverter

FacesConfigConverterType<WebFacesConfigDescriptor> getOrCreateConverter()

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

Returns:

the instance defined for the element converter

createConverter

FacesConfigConverterType<WebFacesConfigDescriptor> createConverter()

Creates a new converter element

Returns:

the new created instance of FacesConfigConverterType

getAllConverter

List<FacesConfigConverterType<WebFacesConfigDescriptor>> getAllConverter()

Returns all converter elements

Returns:

list of converter

removeAllConverter

WebFacesConfigDescriptor removeAllConverter()

Removes all converter elements

Returns:

the current instance of FacesConfigConverterType

getOrCreateManagedBean

FacesConfigManagedBeanType<WebFacesConfigDescriptor> getOrCreateManagedBean()

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

Returns:

the instance defined for the element managed-bean

createManagedBean

FacesConfigManagedBeanType<WebFacesConfigDescriptor> createManagedBean()

Creates a new managed-bean element

Returns:

the new created instance of FacesConfigManagedBeanType

getAllManagedBean

List<FacesConfigManagedBeanType<WebFacesConfigDescriptor>> getAllManagedBean()

Returns all managed-bean elements

Returns:

list of managed-bean

removeAllManagedBean

WebFacesConfigDescriptor removeAllManagedBean()

Removes all managed-bean elements

Returns:

the current instance of FacesConfigManagedBeanType

name

WebFacesConfigDescriptor name(String... values)

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

Parameters:

values - list of name objects

Returns:

the current instance of WebFacesConfigDescriptor

getAllName

List<String> getAllName()

Returns all name elements

Returns:

list of name

removeAllName

WebFacesConfigDescriptor removeAllName()

Removes the name element

Returns:

the current instance of WebFacesConfigDescriptor

getOrCreateNavigationRule

FacesConfigNavigationRuleType<WebFacesConfigDescriptor> getOrCreateNavigationRule()

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

Returns:

the instance defined for the element navigation-rule

createNavigationRule

FacesConfigNavigationRuleType<WebFacesConfigDescriptor> createNavigationRule()

Creates a new navigation-rule element

Returns:

the new created instance of FacesConfigNavigationRuleType

getAllNavigationRule

List<FacesConfigNavigationRuleType<WebFacesConfigDescriptor>> getAllNavigationRule()

Returns all navigation-rule elements

Returns:

list of navigation-rule

removeAllNavigationRule

WebFacesConfigDescriptor removeAllNavigationRule()

Removes all navigation-rule elements

Returns:

the current instance of FacesConfigNavigationRuleType

getOrCreateReferencedBean

FacesConfigReferencedBeanType<WebFacesConfigDescriptor> getOrCreateReferencedBean()

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

Returns:

the instance defined for the element referenced-bean

createReferencedBean

FacesConfigReferencedBeanType<WebFacesConfigDescriptor> createReferencedBean()

Creates a new referenced-bean element

Returns:

the new created instance of FacesConfigReferencedBeanType

getAllReferencedBean

List<FacesConfigReferencedBeanType<WebFacesConfigDescriptor>> getAllReferencedBean()

Returns all referenced-bean elements

Returns:

list of referenced-bean

removeAllReferencedBean

WebFacesConfigDescriptor removeAllReferencedBean()

Removes all referenced-bean elements

Returns:

the current instance of FacesConfigReferencedBeanType

getOrCreateRenderKit

FacesConfigRenderKitType<WebFacesConfigDescriptor> getOrCreateRenderKit()

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

Returns:

the instance defined for the element render-kit

createRenderKit

FacesConfigRenderKitType<WebFacesConfigDescriptor> createRenderKit()

Creates a new render-kit element

Returns:

the new created instance of FacesConfigRenderKitType

getAllRenderKit

List<FacesConfigRenderKitType<WebFacesConfigDescriptor>> getAllRenderKit()

Returns all render-kit elements

Returns:

list of render-kit

removeAllRenderKit

WebFacesConfigDescriptor removeAllRenderKit()

Removes all render-kit elements

Returns:

the current instance of FacesConfigRenderKitType

getOrCreateLifecycle

FacesConfigLifecycleType<WebFacesConfigDescriptor> getOrCreateLifecycle()

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

Returns:

the instance defined for the element lifecycle

createLifecycle

FacesConfigLifecycleType<WebFacesConfigDescriptor> createLifecycle()

Creates a new lifecycle element

Returns:

the new created instance of FacesConfigLifecycleType

getAllLifecycle

List<FacesConfigLifecycleType<WebFacesConfigDescriptor>> getAllLifecycle()

Returns all lifecycle elements

Returns:

list of lifecycle

removeAllLifecycle

WebFacesConfigDescriptor removeAllLifecycle()

Removes all lifecycle elements

Returns:

the current instance of FacesConfigLifecycleType

getOrCreateValidator

FacesConfigValidatorType<WebFacesConfigDescriptor> getOrCreateValidator()

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

Returns:

the instance defined for the element validator

createValidator

FacesConfigValidatorType<WebFacesConfigDescriptor> createValidator()

Creates a new validator element

Returns:

the new created instance of FacesConfigValidatorType

getAllValidator

List<FacesConfigValidatorType<WebFacesConfigDescriptor>> getAllValidator()

Returns all validator elements

Returns:

list of validator

removeAllValidator

WebFacesConfigDescriptor removeAllValidator()

Removes all validator elements

Returns:

the current instance of FacesConfigValidatorType

getOrCreateBehavior

FacesConfigBehaviorType<WebFacesConfigDescriptor> getOrCreateBehavior()

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

Returns:

the instance defined for the element behavior

createBehavior

FacesConfigBehaviorType<WebFacesConfigDescriptor> createBehavior()

Creates a new behavior element

Returns:

the new created instance of FacesConfigBehaviorType

getAllBehavior

List<FacesConfigBehaviorType<WebFacesConfigDescriptor>> getAllBehavior()

Returns all behavior elements

Returns:

list of behavior

removeAllBehavior

WebFacesConfigDescriptor removeAllBehavior()

Removes all behavior elements

Returns:

the current instance of FacesConfigBehaviorType

facesConfigExtension

WebFacesConfigDescriptor facesConfigExtension()

Sets the faces-config-extension element

Returns:

the current instance of WebFacesConfigDescriptor

isFacesConfigExtension

Boolean isFacesConfigExtension()

Removes the faces-config-extension element

Returns:

the current instance of WebFacesConfigDescriptor

removeFacesConfigExtension

WebFacesConfigDescriptor removeFacesConfigExtension()

Removes the faces-config-extension element

Returns:

the current instance of WebFacesConfigDescriptor

metadataComplete

WebFacesConfigDescriptor metadataComplete(Boolean metadataComplete)

Sets the metadata-complete attribute

Parameters:

metadataComplete - the value for the attribute metadata-complete

Returns:

the current instance of WebFacesConfigDescriptor

isMetadataComplete

Boolean isMetadataComplete()

Returns the metadata-complete attribute

Returns:

the value defined for the attribute metadata-complete

removeMetadataComplete

WebFacesConfigDescriptor removeMetadataComplete()

Removes the metadata-complete attribute

Returns:

the current instance of WebFacesConfigDescriptor

version

WebFacesConfigDescriptor version(FacesConfigVersionType version)

Sets the version attribute

Parameters:

version - the value for the attribute version

Returns:

the current instance of WebFacesConfigDescriptor

version

WebFacesConfigDescriptor version(String version)

Sets the version attribute

Parameters:

version - the value for the attribute version

Returns:

the current instance of WebFacesConfigDescriptor

getVersion

FacesConfigVersionType getVersion()

Returns the version attribute

Returns:

the value defined for the attribute version

getVersionAsString

String getVersionAsString()

Returns the version attribute

Returns:

the value found for the element version

removeVersion

WebFacesConfigDescriptor removeVersion()

Removes the version attribute

Returns:

the current instance of WebFacesConfigDescriptor