org.jboss.shrinkwrap.descriptor.api.jsptaglibrary20.WebJsptaglibraryDescriptor Maven / Gradle / Ivy
package org.jboss.shrinkwrap.descriptor.api.jsptaglibrary20;
import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.jsptaglibrary20.ValidatorType;
import org.jboss.shrinkwrap.descriptor.api.j2ee14.ListenerType;
import org.jboss.shrinkwrap.descriptor.api.jsptaglibrary20.TagType;
import org.jboss.shrinkwrap.descriptor.api.jsptaglibrary20.TagFileType;
import org.jboss.shrinkwrap.descriptor.api.jsptaglibrary20.FunctionType;
import org.jboss.shrinkwrap.descriptor.api.jsptaglibrary20.TldExtensionType;
import org.jboss.shrinkwrap.descriptor.api.j2ee14.IconType;
import org.jboss.shrinkwrap.descriptor.api.Descriptor;
import org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace;
/**
*
* This deployment descriptor provides the functionalities as described in the specification
*
* Example:
*
*
* WebJsptaglibraryDescriptor descriptor = Descriptors.create(WebJsptaglibraryDescriptor.class);
*
*
*
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
* @author George Gastaldi
*/
public interface WebJsptaglibraryDescriptor extends Descriptor, DescriptorNamespace {
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebJsptaglibraryDescriptor 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 WebJsptaglibraryDescriptor
*/
public WebJsptaglibraryDescriptor description(String ... values);
/**
* Returns all description elements
* @return list of description
*/
public List getAllDescription();
/**
* Removes the description element
* @return the current instance of WebJsptaglibraryDescriptor
*/
public WebJsptaglibraryDescriptor removeAllDescription();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebJsptaglibraryDescriptor 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 WebJsptaglibraryDescriptor
*/
public WebJsptaglibraryDescriptor 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 WebJsptaglibraryDescriptor
*/
public WebJsptaglibraryDescriptor removeAllDisplayName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebJsptaglibraryDescriptor ElementName: j2ee: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 WebJsptaglibraryDescriptor removeAllIcon();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebJsptaglibraryDescriptor ElementName: xsd:decimal ElementType : tlib-version
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the tlib-version element
* @param tlibVersion the value for the element tlib-version
* @return the current instance of WebJsptaglibraryDescriptor
*/
public WebJsptaglibraryDescriptor tlibVersion(String tlibVersion);
/**
* Returns the tlib-version element
* @return the node defined for the element tlib-version
*/
public String getTlibVersion();
/**
* Removes the tlib-version element
* @return the current instance of WebJsptaglibraryDescriptor
*/
public WebJsptaglibraryDescriptor removeTlibVersion();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebJsptaglibraryDescriptor ElementName: j2ee:xsdNMTOKENType ElementType : short-name
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the short-name element
* @param shortName the value for the element short-name
* @return the current instance of WebJsptaglibraryDescriptor
*/
public WebJsptaglibraryDescriptor shortName(String shortName);
/**
* Returns the short-name element
* @return the node defined for the element short-name
*/
public String getShortName();
/**
* Removes the short-name element
* @return the current instance of WebJsptaglibraryDescriptor
*/
public WebJsptaglibraryDescriptor removeShortName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebJsptaglibraryDescriptor ElementName: xsd:anyURI ElementType : uri
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the uri element
* @param uri the value for the element uri
* @return the current instance of WebJsptaglibraryDescriptor
*/
public WebJsptaglibraryDescriptor uri(String uri);
/**
* Returns the uri element
* @return the node defined for the element uri
*/
public String getUri();
/**
* Removes the uri element
* @return the current instance of WebJsptaglibraryDescriptor
*/
public WebJsptaglibraryDescriptor removeUri();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebJsptaglibraryDescriptor ElementName: j2ee:validatorType ElementType : validator
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new validator element with the given value will be created.
* Otherwise, the existing validator element will be returned.
* @return a new or existing instance of ValidatorType
*/
public ValidatorType getOrCreateValidator();
/**
* Removes the validator element
* @return the current instance of WebJsptaglibraryDescriptor
*/
public WebJsptaglibraryDescriptor removeValidator();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebJsptaglibraryDescriptor ElementName: j2ee:listenerType ElementType : listener
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new listener element will be created and returned.
* Otherwise, the first existing listener element will be returned.
* @return the instance defined for the element listener
*/
public ListenerType getOrCreateListener();
/**
* Creates a new listener element
* @return the new created instance of ListenerType
*/
public ListenerType createListener();
/**
* Returns all listener elements
* @return list of listener
*/
public List> getAllListener();
/**
* Removes all listener elements
* @return the current instance of ListenerType
*/
public WebJsptaglibraryDescriptor removeAllListener();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebJsptaglibraryDescriptor ElementName: j2ee: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 TagType getOrCreateTag();
/**
* Creates a new tag element
* @return the new created instance of TagType
*/
public TagType createTag();
/**
* Returns all tag elements
* @return list of tag
*/
public List> getAllTag();
/**
* Removes all tag elements
* @return the current instance of TagType
*/
public WebJsptaglibraryDescriptor removeAllTag();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebJsptaglibraryDescriptor ElementName: j2ee:tagFileType ElementType : tag-file
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new tag-file element will be created and returned.
* Otherwise, the first existing tag-file element will be returned.
* @return the instance defined for the element tag-file
*/
public TagFileType getOrCreateTagFile();
/**
* Creates a new tag-file element
* @return the new created instance of TagFileType
*/
public TagFileType createTagFile();
/**
* Returns all tag-file elements
* @return list of tag-file
*/
public List> getAllTagFile();
/**
* Removes all tag-file elements
* @return the current instance of TagFileType
*/
public WebJsptaglibraryDescriptor removeAllTagFile();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebJsptaglibraryDescriptor ElementName: j2ee: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 FunctionType getOrCreateFunction();
/**
* Creates a new function element
* @return the new created instance of FunctionType
*/
public FunctionType createFunction();
/**
* Returns all function elements
* @return list of function
*/
public List> getAllFunction();
/**
* Removes all function elements
* @return the current instance of FunctionType
*/
public WebJsptaglibraryDescriptor removeAllFunction();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebJsptaglibraryDescriptor ElementName: j2ee:tld-extensionType ElementType : taglib-extension
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new taglib-extension element will be created and returned.
* Otherwise, the first existing taglib-extension element will be returned.
* @return the instance defined for the element taglib-extension
*/
public TldExtensionType getOrCreateTaglibExtension();
/**
* Creates a new taglib-extension element
* @return the new created instance of TldExtensionType
*/
public TldExtensionType createTaglibExtension();
/**
* Returns all taglib-extension elements
* @return list of taglib-extension
*/
public List> getAllTaglibExtension();
/**
* Removes all taglib-extension elements
* @return the current instance of TldExtensionType
*/
public WebJsptaglibraryDescriptor removeAllTaglibExtension();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebJsptaglibraryDescriptor ElementName: xsd:decimal ElementType : version
// MaxOccurs: - isGeneric: false isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
public static final String VERSION = "2.0";
/**
* Sets the version attribute
* @param version the value for the attribute version
* @return the current instance of WebJsptaglibraryDescriptor
*/
public WebJsptaglibraryDescriptor version(String version);
/**
* Returns the version attribute
* @return the value defined for the attribute version
*/
public String getVersion();
/**
* Removes the version attribute
* @return the current instance of WebJsptaglibraryDescriptor
*/
public WebJsptaglibraryDescriptor removeVersion();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebJsptaglibraryDescriptor 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 WebJsptaglibraryDescriptor
*/
public WebJsptaglibraryDescriptor 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 WebJsptaglibraryDescriptor
*/
public WebJsptaglibraryDescriptor removeId();
}