org.jboss.shrinkwrap.descriptor.api.facesconfig20.WebFacesConfigDescriptor Maven / Gradle / Ivy
package org.jboss.shrinkwrap.descriptor.api.facesconfig20;
import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigApplicationType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigOrderingType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigAbsoluteOrderingType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigFactoryType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigComponentType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigConverterType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigManagedBeanType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigNavigationRuleType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigReferencedBeanType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigRenderKitType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigLifecycleType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigValidatorType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigBehaviorType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigVersionType;
import org.jboss.shrinkwrap.descriptor.api.Descriptor;
import org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace;
import org.jboss.shrinkwrap.descriptor.api.facesconfig.*;
/**
*
* This deployment descriptor provides the functionalities as described in the specification
*
* Example:
*
*
* WebFacesConfigDescriptor descriptor = Descriptors.create(WebFacesConfigDescriptor.class);
*
*
*
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
* @author George Gastaldi
*/
public interface WebFacesConfigDescriptor extends Descriptor, DescriptorNamespace,
WebFacesConfigCommonDescriptor> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacesConfigDescriptor ElementName: javaee:faces-config-applicationType ElementType : application
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new application element will be created and returned.
* Otherwise, the first existing application element will be returned.
* @return the instance defined for the element application
*/
public FacesConfigApplicationType getOrCreateApplication();
/**
* Creates a new application element
* @return the new created instance of FacesConfigApplicationType
*/
public FacesConfigApplicationType createApplication();
/**
* Returns all application elements
* @return list of application
*/
public List> getAllApplication();
/**
* Removes all application elements
* @return the current instance of FacesConfigApplicationType
*/
public WebFacesConfigDescriptor removeAllApplication();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacesConfigDescriptor ElementName: javaee:faces-config-orderingType ElementType : ordering
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new ordering element will be created and returned.
* Otherwise, the first existing ordering element will be returned.
* @return the instance defined for the element ordering
*/
public FacesConfigOrderingType getOrCreateOrdering();
/**
* Creates a new ordering element
* @return the new created instance of FacesConfigOrderingType
*/
public FacesConfigOrderingType createOrdering();
/**
* Returns all ordering elements
* @return list of ordering
*/
public List> getAllOrdering();
/**
* Removes all ordering elements
* @return the current instance of FacesConfigOrderingType
*/
public WebFacesConfigDescriptor removeAllOrdering();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacesConfigDescriptor ElementName: javaee:faces-config-absoluteOrderingType ElementType : absolute-ordering
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new absolute-ordering element will be created and returned.
* Otherwise, the first existing absolute-ordering element will be returned.
* @return the instance defined for the element absolute-ordering
*/
public FacesConfigAbsoluteOrderingType getOrCreateAbsoluteOrdering();
/**
* Creates a new absolute-ordering element
* @return the new created instance of FacesConfigAbsoluteOrderingType
*/
public FacesConfigAbsoluteOrderingType createAbsoluteOrdering();
/**
* Returns all absolute-ordering elements
* @return list of absolute-ordering
*/
public List> getAllAbsoluteOrdering();
/**
* Removes all absolute-ordering elements
* @return the current instance of FacesConfigAbsoluteOrderingType
*/
public WebFacesConfigDescriptor removeAllAbsoluteOrdering();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacesConfigDescriptor ElementName: javaee:faces-config-factoryType ElementType : factory
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new factory element will be created and returned.
* Otherwise, the first existing factory element will be returned.
* @return the instance defined for the element factory
*/
public FacesConfigFactoryType getOrCreateFactory();
/**
* Creates a new factory element
* @return the new created instance of FacesConfigFactoryType
*/
public FacesConfigFactoryType createFactory();
/**
* Returns all factory elements
* @return list of factory
*/
public List> getAllFactory();
/**
* Removes all factory elements
* @return the current instance of FacesConfigFactoryType
*/
public WebFacesConfigDescriptor removeAllFactory();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacesConfigDescriptor ElementName: javaee:faces-config-componentType ElementType : component
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new component element will be created and returned.
* Otherwise, the first existing component element will be returned.
* @return the instance defined for the element component
*/
public FacesConfigComponentType getOrCreateComponent();
/**
* Creates a new component element
* @return the new created instance of FacesConfigComponentType
*/
public FacesConfigComponentType createComponent();
/**
* Returns all component elements
* @return list of component
*/
public List> getAllComponent();
/**
* Removes all component elements
* @return the current instance of FacesConfigComponentType
*/
public WebFacesConfigDescriptor removeAllComponent();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacesConfigDescriptor ElementName: javaee:faces-config-converterType ElementType : converter
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new converter element will be created and returned.
* Otherwise, the first existing converter element will be returned.
* @return the instance defined for the element converter
*/
public FacesConfigConverterType getOrCreateConverter();
/**
* Creates a new converter element
* @return the new created instance of FacesConfigConverterType
*/
public FacesConfigConverterType createConverter();
/**
* Returns all converter elements
* @return list of converter
*/
public List> getAllConverter();
/**
* Removes all converter elements
* @return the current instance of FacesConfigConverterType
*/
public WebFacesConfigDescriptor removeAllConverter();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacesConfigDescriptor ElementName: javaee:faces-config-managed-beanType ElementType : managed-bean
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new managed-bean element will be created and returned.
* Otherwise, the first existing managed-bean element will be returned.
* @return the instance defined for the element managed-bean
*/
public FacesConfigManagedBeanType getOrCreateManagedBean();
/**
* Creates a new managed-bean element
* @return the new created instance of FacesConfigManagedBeanType
*/
public FacesConfigManagedBeanType createManagedBean();
/**
* Returns all managed-bean elements
* @return list of managed-bean
*/
public List> getAllManagedBean();
/**
* Removes all managed-bean elements
* @return the current instance of FacesConfigManagedBeanType
*/
public WebFacesConfigDescriptor removeAllManagedBean();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacesConfigDescriptor ElementName: xsd:token ElementType : name
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Creates for all String objects representing name elements,
* a new name element
* @param values list of name objects
* @return the current instance of WebFacesConfigDescriptor
*/
public WebFacesConfigDescriptor name(String ... values);
/**
* Returns all name elements
* @return list of name
*/
public List getAllName();
/**
* Removes the name element
* @return the current instance of WebFacesConfigDescriptor
*/
public WebFacesConfigDescriptor removeAllName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacesConfigDescriptor ElementName: javaee:faces-config-navigation-ruleType ElementType : navigation-rule
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new navigation-rule element will be created and returned.
* Otherwise, the first existing navigation-rule element will be returned.
* @return the instance defined for the element navigation-rule
*/
public FacesConfigNavigationRuleType getOrCreateNavigationRule();
/**
* Creates a new navigation-rule element
* @return the new created instance of FacesConfigNavigationRuleType
*/
public FacesConfigNavigationRuleType createNavigationRule();
/**
* Returns all navigation-rule elements
* @return list of navigation-rule
*/
public List> getAllNavigationRule();
/**
* Removes all navigation-rule elements
* @return the current instance of FacesConfigNavigationRuleType
*/
public WebFacesConfigDescriptor removeAllNavigationRule();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacesConfigDescriptor ElementName: javaee:faces-config-referenced-beanType ElementType : referenced-bean
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new referenced-bean element will be created and returned.
* Otherwise, the first existing referenced-bean element will be returned.
* @return the instance defined for the element referenced-bean
*/
public FacesConfigReferencedBeanType getOrCreateReferencedBean();
/**
* Creates a new referenced-bean element
* @return the new created instance of FacesConfigReferencedBeanType
*/
public FacesConfigReferencedBeanType createReferencedBean();
/**
* Returns all referenced-bean elements
* @return list of referenced-bean
*/
public List> getAllReferencedBean();
/**
* Removes all referenced-bean elements
* @return the current instance of FacesConfigReferencedBeanType
*/
public WebFacesConfigDescriptor removeAllReferencedBean();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacesConfigDescriptor ElementName: javaee:faces-config-render-kitType ElementType : render-kit
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new render-kit element will be created and returned.
* Otherwise, the first existing render-kit element will be returned.
* @return the instance defined for the element render-kit
*/
public FacesConfigRenderKitType getOrCreateRenderKit();
/**
* Creates a new render-kit element
* @return the new created instance of FacesConfigRenderKitType
*/
public FacesConfigRenderKitType createRenderKit();
/**
* Returns all render-kit elements
* @return list of render-kit
*/
public List> getAllRenderKit();
/**
* Removes all render-kit elements
* @return the current instance of FacesConfigRenderKitType
*/
public WebFacesConfigDescriptor removeAllRenderKit();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacesConfigDescriptor ElementName: javaee:faces-config-lifecycleType ElementType : lifecycle
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new lifecycle element will be created and returned.
* Otherwise, the first existing lifecycle element will be returned.
* @return the instance defined for the element lifecycle
*/
public FacesConfigLifecycleType getOrCreateLifecycle();
/**
* Creates a new lifecycle element
* @return the new created instance of FacesConfigLifecycleType
*/
public FacesConfigLifecycleType createLifecycle();
/**
* Returns all lifecycle elements
* @return list of lifecycle
*/
public List> getAllLifecycle();
/**
* Removes all lifecycle elements
* @return the current instance of FacesConfigLifecycleType
*/
public WebFacesConfigDescriptor removeAllLifecycle();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacesConfigDescriptor ElementName: javaee:faces-config-validatorType ElementType : validator
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new validator element will be created and returned.
* Otherwise, the first existing validator element will be returned.
* @return the instance defined for the element validator
*/
public FacesConfigValidatorType getOrCreateValidator();
/**
* Creates a new validator element
* @return the new created instance of FacesConfigValidatorType
*/
public FacesConfigValidatorType createValidator();
/**
* Returns all validator elements
* @return list of validator
*/
public List> getAllValidator();
/**
* Removes all validator elements
* @return the current instance of FacesConfigValidatorType
*/
public WebFacesConfigDescriptor removeAllValidator();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacesConfigDescriptor ElementName: javaee:faces-config-behaviorType ElementType : behavior
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new behavior element will be created and returned.
* Otherwise, the first existing behavior element will be returned.
* @return the instance defined for the element behavior
*/
public FacesConfigBehaviorType getOrCreateBehavior();
/**
* Creates a new behavior element
* @return the new created instance of FacesConfigBehaviorType
*/
public FacesConfigBehaviorType createBehavior();
/**
* Returns all behavior elements
* @return list of behavior
*/
public List> getAllBehavior();
/**
* Removes all behavior elements
* @return the current instance of FacesConfigBehaviorType
*/
public WebFacesConfigDescriptor removeAllBehavior();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacesConfigDescriptor ElementName: javaee:faces-config-extensionType ElementType : faces-config-extension
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the faces-config-extension element
* @return the current instance of WebFacesConfigDescriptor
*/
public WebFacesConfigDescriptor facesConfigExtension();
/**
* Removes the faces-config-extension element
* @return the current instance of WebFacesConfigDescriptor
*/
public Boolean isFacesConfigExtension();
/**
* Removes the faces-config-extension element
* @return the current instance of WebFacesConfigDescriptor
*/
public WebFacesConfigDescriptor removeFacesConfigExtension();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacesConfigDescriptor ElementName: xsd:boolean ElementType : metadata-complete
// MaxOccurs: - isGeneric: false isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the metadata-complete attribute
* @param metadataComplete the value for the attribute metadata-complete
* @return the current instance of WebFacesConfigDescriptor
*/
public WebFacesConfigDescriptor metadataComplete(Boolean metadataComplete);
/**
* Returns the metadata-complete attribute
* @return the value defined for the attribute metadata-complete
*/
public Boolean isMetadataComplete();
/**
* Removes the metadata-complete attribute
* @return the current instance of WebFacesConfigDescriptor
*/
public WebFacesConfigDescriptor removeMetadataComplete();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacesConfigDescriptor ElementName: xsd:ID ElementType : id
// MaxOccurs: - isGeneric: false isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the id attribute
* @param id the value for the attribute id
* @return the current instance of WebFacesConfigDescriptor
*/
public WebFacesConfigDescriptor id(String id);
/**
* Returns the id attribute
* @return the value defined for the attribute id
*/
public String getId();
/**
* Removes the id attribute
* @return the current instance of WebFacesConfigDescriptor
*/
public WebFacesConfigDescriptor removeId();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacesConfigDescriptor ElementName: javaee:faces-config-versionType ElementType : version
// MaxOccurs: - isGeneric: false isAttribute: true isEnum: true isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the version attribute
* @param version the value for the attribute version
* @return the current instance of WebFacesConfigDescriptor
*/
public WebFacesConfigDescriptor version(FacesConfigVersionType version);
/**
* Sets the version attribute
* @param version the value for the attribute version
* @return the current instance of WebFacesConfigDescriptor
*/
public WebFacesConfigDescriptor version(String version);
/**
* Returns the version attribute
* @return the value defined for the attribute version
*/
public FacesConfigVersionType getVersion();
/**
* Returns the version attribute
* @return the value found for the element version
*/
public String getVersionAsString();
/**
* Removes the version attribute
* @return the current instance of WebFacesConfigDescriptor
*/
public WebFacesConfigDescriptor removeVersion();
}