org.jboss.shrinkwrap.descriptor.api.jsptaglibrary20.TagType 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.BodyContentType;
import org.jboss.shrinkwrap.descriptor.api.jsptaglibrary20.VariableType;
import org.jboss.shrinkwrap.descriptor.api.jsptaglibrary20.TldAttributeType;
import org.jboss.shrinkwrap.descriptor.api.j2ee14.GenericBooleanType;
import org.jboss.shrinkwrap.descriptor.api.jsptaglibrary20.TldExtensionType;
import org.jboss.shrinkwrap.descriptor.api.j2ee14.IconType;
/**
* This interface defines the contract for the tagType xsd type
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
* @author George Gastaldi
*/
public interface TagType extends Child {
// --------------------------------------------------------------------------------------------------------||
// ClassName: TagType ElementName: xsd:string ElementType : description
// MaxOccurs: -unbounded isGeneric: true 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 TagType
*/
public TagType description(String ... values);
/**
* Returns all description elements
* @return list of description
*/
public List getAllDescription();
/**
* Removes the description element
* @return the current instance of TagType
*/
public TagType removeAllDescription();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TagType ElementName: xsd:token ElementType : display-name
// MaxOccurs: -unbounded isGeneric: true 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 TagType
*/
public TagType 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 TagType
*/
public TagType removeAllDisplayName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TagType ElementName: j2ee:iconType ElementType : icon
// MaxOccurs: -unbounded isGeneric: true 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 TagType removeAllIcon();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TagType ElementName: j2ee:xsdNMTOKENType ElementType : name
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the name element
* @param name the value for the element name
* @return the current instance of TagType
*/
public TagType name(String name);
/**
* Returns the name element
* @return the node defined for the element name
*/
public String getName();
/**
* Removes the name element
* @return the current instance of TagType
*/
public TagType removeName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TagType ElementName: xsd:token ElementType : tag-class
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the tag-class element
* @param tagClass the value for the element tag-class
* @return the current instance of TagType
*/
public TagType tagClass(String tagClass);
/**
* Returns the tag-class element
* @return the node defined for the element tag-class
*/
public String getTagClass();
/**
* Removes the tag-class element
* @return the current instance of TagType
*/
public TagType removeTagClass();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TagType ElementName: xsd:token ElementType : tei-class
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the tei-class element
* @param teiClass the value for the element tei-class
* @return the current instance of TagType
*/
public TagType teiClass(String teiClass);
/**
* Returns the tei-class element
* @return the node defined for the element tei-class
*/
public String getTeiClass();
/**
* Removes the tei-class element
* @return the current instance of TagType
*/
public TagType removeTeiClass();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TagType ElementName: j2ee:body-contentType ElementType : body-content
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: true isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the body-content element
* @param bodyContent the value for the element body-content
* @return the current instance of TagType
*/
public TagType bodyContent(BodyContentType bodyContent);
/**
* Sets the body-content element
* @param bodyContent the value for the element body-content
* @return the current instance of TagType
*/
public TagType bodyContent(String bodyContent);
/**
* Returns the body-content element
* @return the value found for the element body-content
*/
public BodyContentType getBodyContent();
/**
* Returns the body-content element
* @return the value found for the element body-content
*/
public String getBodyContentAsString();
/**
* Removes the body-content attribute
* @return the current instance of TagType
*/
public TagType removeBodyContent();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TagType ElementName: j2ee:variableType ElementType : variable
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new variable element will be created and returned.
* Otherwise, the first existing variable element will be returned.
* @return the instance defined for the element variable
*/
public VariableType> getOrCreateVariable();
/**
* Creates a new variable element
* @return the new created instance of VariableType>
*/
public VariableType> createVariable();
/**
* Returns all variable elements
* @return list of variable
*/
public List>> getAllVariable();
/**
* Removes all variable elements
* @return the current instance of VariableType>
*/
public TagType removeAllVariable();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TagType ElementName: j2ee:tld-attributeType ElementType : attribute
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new attribute element will be created and returned.
* Otherwise, the first existing attribute element will be returned.
* @return the instance defined for the element attribute
*/
public TldAttributeType> getOrCreateAttribute();
/**
* Creates a new attribute element
* @return the new created instance of TldAttributeType>
*/
public TldAttributeType> createAttribute();
/**
* Returns all attribute elements
* @return list of attribute
*/
public List>> getAllAttribute();
/**
* Removes all attribute elements
* @return the current instance of TldAttributeType>
*/
public TagType removeAllAttribute();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TagType ElementName: j2ee:generic-booleanType ElementType : dynamic-attributes
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: true isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the dynamic-attributes element
* @param dynamicAttributes the value for the element dynamic-attributes
* @return the current instance of TagType
*/
public TagType dynamicAttributes(GenericBooleanType dynamicAttributes);
/**
* Sets the dynamic-attributes element
* @param dynamicAttributes the value for the element dynamic-attributes
* @return the current instance of TagType
*/
public TagType dynamicAttributes(String dynamicAttributes);
/**
* Returns the dynamic-attributes element
* @return the value found for the element dynamic-attributes
*/
public GenericBooleanType getDynamicAttributes();
/**
* Returns the dynamic-attributes element
* @return the value found for the element dynamic-attributes
*/
public String getDynamicAttributesAsString();
/**
* Removes the dynamic-attributes attribute
* @return the current instance of TagType
*/
public TagType removeDynamicAttributes();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TagType ElementName: xsd:string ElementType : example
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the example element
* @param example the value for the element example
* @return the current instance of TagType
*/
public TagType example(String example);
/**
* Returns the example element
* @return the node defined for the element example
*/
public String getExample();
/**
* Removes the example element
* @return the current instance of TagType
*/
public TagType removeExample();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TagType ElementName: j2ee:tld-extensionType ElementType : tag-extension
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new tag-extension element will be created and returned.
* Otherwise, the first existing tag-extension element will be returned.
* @return the instance defined for the element tag-extension
*/
public TldExtensionType> getOrCreateTagExtension();
/**
* Creates a new tag-extension element
* @return the new created instance of TldExtensionType>
*/
public TldExtensionType> createTagExtension();
/**
* Returns all tag-extension elements
* @return list of tag-extension
*/
public List>> getAllTagExtension();
/**
* Removes all tag-extension elements
* @return the current instance of TldExtensionType>
*/
public TagType removeAllTagExtension();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TagType ElementName: xsd:ID ElementType : id
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the id attribute
* @param id the value for the attribute id
* @return the current instance of TagType
*/
public TagType 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 TagType
*/
public TagType removeId();
}