org.jboss.shrinkwrap.descriptor.api.jsptaglibrary21.FunctionType Maven / Gradle / Ivy
package org.jboss.shrinkwrap.descriptor.api.jsptaglibrary21;
import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.jsptaglibrary21.TldExtensionType;
import org.jboss.shrinkwrap.descriptor.api.javaee5.IconType;
/**
* This interface defines the contract for the functionType xsd type
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
* @author George Gastaldi
*/
public interface FunctionType extends Child {
// --------------------------------------------------------------------------------------------------------||
// ClassName: FunctionType 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 FunctionType
*/
public FunctionType description(String ... values);
/**
* Returns all description elements
* @return list of description
*/
public List getAllDescription();
/**
* Removes the description element
* @return the current instance of FunctionType
*/
public FunctionType removeAllDescription();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FunctionType 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 FunctionType
*/
public FunctionType 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 FunctionType
*/
public FunctionType removeAllDisplayName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FunctionType ElementName: javaee: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 FunctionType removeAllIcon();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FunctionType ElementName: javaee: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 FunctionType
*/
public FunctionType 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 FunctionType
*/
public FunctionType removeName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FunctionType ElementName: xsd:token ElementType : function-class
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the function-class element
* @param functionClass the value for the element function-class
* @return the current instance of FunctionType
*/
public FunctionType functionClass(String functionClass);
/**
* Returns the function-class element
* @return the node defined for the element function-class
*/
public String getFunctionClass();
/**
* Removes the function-class element
* @return the current instance of FunctionType
*/
public FunctionType removeFunctionClass();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FunctionType ElementName: xsd:token ElementType : function-signature
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the function-signature element
* @param functionSignature the value for the element function-signature
* @return the current instance of FunctionType
*/
public FunctionType functionSignature(String functionSignature);
/**
* Returns the function-signature element
* @return the node defined for the element function-signature
*/
public String getFunctionSignature();
/**
* Removes the function-signature element
* @return the current instance of FunctionType
*/
public FunctionType removeFunctionSignature();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FunctionType 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 FunctionType
*/
public FunctionType 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 FunctionType
*/
public FunctionType removeExample();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FunctionType ElementName: javaee:tld-extensionType ElementType : function-extension
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new function-extension element will be created and returned.
* Otherwise, the first existing function-extension element will be returned.
* @return the instance defined for the element function-extension
*/
public TldExtensionType> getOrCreateFunctionExtension();
/**
* Creates a new function-extension element
* @return the new created instance of TldExtensionType>
*/
public TldExtensionType> createFunctionExtension();
/**
* Returns all function-extension elements
* @return list of function-extension
*/
public List>> getAllFunctionExtension();
/**
* Removes all function-extension elements
* @return the current instance of TldExtensionType>
*/
public FunctionType removeAllFunctionExtension();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FunctionType 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 FunctionType
*/
public FunctionType 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 FunctionType
*/
public FunctionType removeId();
}