org.jboss.shrinkwrap.descriptor.api.facelettaglibrary20.WebFacelettaglibraryDescriptor Maven / Gradle / Ivy
Show all versions of shrinkwrap-descriptors-api-javaee Show documentation
package org.jboss.shrinkwrap.descriptor.api.facelettaglibrary20;
import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.facelettaglibrary20.FaceletTaglibTagType;
import org.jboss.shrinkwrap.descriptor.api.facelettaglibrary20.FaceletTaglibFunctionType;
import org.jboss.shrinkwrap.descriptor.api.facelettaglibrary20.FaceletTaglibVersionType;
import org.jboss.shrinkwrap.descriptor.api.javaee5.IconType;
import org.jboss.shrinkwrap.descriptor.api.Descriptor;
import org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace;
import org.jboss.shrinkwrap.descriptor.api.facelettaglibrary.*;
/**
*
* This deployment descriptor provides the functionalities as described in the specification
*
* Example:
*
*
* WebFacelettaglibraryDescriptor descriptor = Descriptors.create(WebFacelettaglibraryDescriptor.class);
*
*
*
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
* @author George Gastaldi
*/
public interface WebFacelettaglibraryDescriptor extends Descriptor, DescriptorNamespace,
WebFacelettaglibraryCommonDescriptor,
FaceletTaglibFunctionType> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacelettaglibraryDescriptor ElementName: xsd:string ElementType : description
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Creates for all String objects representing description elements,
* a new description element
* @param values list of description objects
* @return the current instance of WebFacelettaglibraryDescriptor
*/
public WebFacelettaglibraryDescriptor description(String ... values);
/**
* Returns all description elements
* @return list of description
*/
public List getAllDescription();
/**
* Removes the description element
* @return the current instance of WebFacelettaglibraryDescriptor
*/
public WebFacelettaglibraryDescriptor removeAllDescription();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacelettaglibraryDescriptor ElementName: xsd:token ElementType : display-name
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Creates for all String objects representing display-name elements,
* a new display-name element
* @param values list of display-name objects
* @return the current instance of WebFacelettaglibraryDescriptor
*/
public WebFacelettaglibraryDescriptor displayName(String ... values);
/**
* Returns all display-name elements
* @return list of display-name
*/
public List getAllDisplayName();
/**
* Removes the display-name element
* @return the current instance of WebFacelettaglibraryDescriptor
*/
public WebFacelettaglibraryDescriptor removeAllDisplayName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacelettaglibraryDescriptor ElementName: javaee:iconType ElementType : icon
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new icon element will be created and returned.
* Otherwise, the first existing icon element will be returned.
* @return the instance defined for the element icon
*/
public IconType getOrCreateIcon();
/**
* Creates a new icon element
* @return the new created instance of IconType
*/
public IconType createIcon();
/**
* Returns all icon elements
* @return list of icon
*/
public List> getAllIcon();
/**
* Removes all icon elements
* @return the current instance of IconType
*/
public WebFacelettaglibraryDescriptor removeAllIcon();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacelettaglibraryDescriptor ElementName: xsd:token ElementType : library-class
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the library-class element
* @param libraryClass the value for the element library-class
* @return the current instance of WebFacelettaglibraryDescriptor
*/
public WebFacelettaglibraryDescriptor libraryClass(String libraryClass);
/**
* Returns the library-class element
* @return the node defined for the element library-class
*/
public String getLibraryClass();
/**
* Removes the library-class element
* @return the current instance of WebFacelettaglibraryDescriptor
*/
public WebFacelettaglibraryDescriptor removeLibraryClass();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacelettaglibraryDescriptor ElementName: xsd:token ElementType : namespace
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the namespace element
* @param namespace the value for the element namespace
* @return the current instance of WebFacelettaglibraryDescriptor
*/
public WebFacelettaglibraryDescriptor namespace(String namespace);
/**
* Returns the namespace element
* @return the node defined for the element namespace
*/
public String getNamespace();
/**
* Removes the namespace element
* @return the current instance of WebFacelettaglibraryDescriptor
*/
public WebFacelettaglibraryDescriptor removeNamespace();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacelettaglibraryDescriptor ElementName: xsd:token ElementType : composite-library-name
// MaxOccurs: -1 isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the composite-library-name element
* @param compositeLibraryName the value for the element composite-library-name
* @return the current instance of WebFacelettaglibraryDescriptor
*/
public WebFacelettaglibraryDescriptor compositeLibraryName(String compositeLibraryName);
/**
* Returns the composite-library-name element
* @return the node defined for the element composite-library-name
*/
public String getCompositeLibraryName();
/**
* Removes the composite-library-name element
* @return the current instance of WebFacelettaglibraryDescriptor
*/
public WebFacelettaglibraryDescriptor removeCompositeLibraryName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacelettaglibraryDescriptor ElementName: javaee:facelet-taglib-tagType ElementType : tag
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new tag element will be created and returned.
* Otherwise, the first existing tag element will be returned.
* @return the instance defined for the element tag
*/
public FaceletTaglibTagType getOrCreateTag();
/**
* Creates a new tag element
* @return the new created instance of FaceletTaglibTagType
*/
public FaceletTaglibTagType createTag();
/**
* Returns all tag elements
* @return list of tag
*/
public List> getAllTag();
/**
* Removes all tag elements
* @return the current instance of FaceletTaglibTagType
*/
public WebFacelettaglibraryDescriptor removeAllTag();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacelettaglibraryDescriptor ElementName: javaee:facelet-taglib-functionType ElementType : function
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new function element will be created and returned.
* Otherwise, the first existing function element will be returned.
* @return the instance defined for the element function
*/
public FaceletTaglibFunctionType getOrCreateFunction();
/**
* Creates a new function element
* @return the new created instance of FaceletTaglibFunctionType
*/
public FaceletTaglibFunctionType createFunction();
/**
* Returns all function elements
* @return list of function
*/
public List> getAllFunction();
/**
* Removes all function elements
* @return the current instance of FaceletTaglibFunctionType
*/
public WebFacelettaglibraryDescriptor removeAllFunction();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacelettaglibraryDescriptor ElementName: javaee:facelet-taglib-extensionType ElementType : taglib-extension
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the taglib-extension element
* @return the current instance of WebFacelettaglibraryDescriptor
*/
public WebFacelettaglibraryDescriptor taglibExtension();
/**
* Removes the taglib-extension element
* @return the current instance of WebFacelettaglibraryDescriptor
*/
public Boolean isTaglibExtension();
/**
* Removes the taglib-extension element
* @return the current instance of WebFacelettaglibraryDescriptor
*/
public WebFacelettaglibraryDescriptor removeTaglibExtension();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacelettaglibraryDescriptor 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 WebFacelettaglibraryDescriptor
*/
public WebFacelettaglibraryDescriptor 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 WebFacelettaglibraryDescriptor
*/
public WebFacelettaglibraryDescriptor removeId();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebFacelettaglibraryDescriptor ElementName: javaee:facelet-taglib-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 WebFacelettaglibraryDescriptor
*/
public WebFacelettaglibraryDescriptor version(FaceletTaglibVersionType version);
/**
* Sets the version attribute
* @param version the value for the attribute version
* @return the current instance of WebFacelettaglibraryDescriptor
*/
public WebFacelettaglibraryDescriptor version(String version);
/**
* Returns the version attribute
* @return the value defined for the attribute version
*/
public FaceletTaglibVersionType 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 WebFacelettaglibraryDescriptor
*/
public WebFacelettaglibraryDescriptor removeVersion();
}