org.jboss.shrinkwrap.descriptor.api.webcommon30.FilterType Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of shrinkwrap-descriptors-api-javaee Show documentation
Show all versions of shrinkwrap-descriptors-api-javaee Show documentation
Client View of the ShrinkWrap Descriptors Project
The newest version!
package org.jboss.shrinkwrap.descriptor.api.webcommon30;
import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.javaee6.ParamValueType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.IconType;
import org.jboss.shrinkwrap.descriptor.api.webcommon.*;
import org.jboss.shrinkwrap.descriptor.api.javaee.*;
import org.jboss.shrinkwrap.descriptor.api.jsp.*;
import org.jboss.shrinkwrap.descriptor.api.webapp.JavaeeFilterCommonType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.ParamValueType;/**
* This interface defines the contract for the filterType
xsd type
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
* @author George Gastaldi
*/
public interface FilterType extends Child,
JavaeeFilterCommonType,
ParamValueType>> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: FilterType 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 FilterType
*/
public FilterType description(String ... values);
/**
* Returns all description
elements
* @return list of description
*/
public List getAllDescription();
/**
* Removes the description
element
* @return the current instance of FilterType
*/
public FilterType removeAllDescription();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FilterType 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 FilterType
*/
public FilterType 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 FilterType
*/
public FilterType removeAllDisplayName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FilterType 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 FilterType removeAllIcon();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FilterType ElementName: javaee:nonEmptyStringType ElementType : filter-name
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the filter-name
element
* @param filterName the value for the element filter-name
* @return the current instance of FilterType
*/
public FilterType filterName(String filterName);
/**
* Returns the filter-name
element
* @return the node defined for the element filter-name
*/
public String getFilterName();
/**
* Removes the filter-name
element
* @return the current instance of FilterType
*/
public FilterType removeFilterName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FilterType ElementName: xsd:token ElementType : filter-class
// MaxOccurs: -1 isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the filter-class
element
* @param filterClass the value for the element filter-class
* @return the current instance of FilterType
*/
public FilterType filterClass(String filterClass);
/**
* Returns the filter-class
element
* @return the node defined for the element filter-class
*/
public String getFilterClass();
/**
* Removes the filter-class
element
* @return the current instance of FilterType
*/
public FilterType removeFilterClass();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FilterType ElementName: javaee:xsdBooleanType ElementType : async-supported
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the async-supported
element
* @param asyncSupported the value for the element async-supported
* @return the current instance of FilterType
*/
public FilterType asyncSupported(Boolean asyncSupported);
/**
* Returns the async-supported
element
* @return the node defined for the element async-supported
*/
public Boolean isAsyncSupported();
/**
* Removes the async-supported
element
* @return the current instance of FilterType
*/
public FilterType removeAsyncSupported();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FilterType ElementName: javaee:param-valueType ElementType : init-param
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new init-param
element will be created and returned.
* Otherwise, the first existing init-param
element will be returned.
* @return the instance defined for the element init-param
*/
public ParamValueType> getOrCreateInitParam();
/**
* Creates a new init-param
element
* @return the new created instance of ParamValueType>
*/
public ParamValueType> createInitParam();
/**
* Returns all init-param
elements
* @return list of init-param
*/
public List>> getAllInitParam();
/**
* Removes all init-param
elements
* @return the current instance of ParamValueType>
*/
public FilterType removeAllInitParam();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FilterType 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 FilterType
*/
public FilterType 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 FilterType
*/
public FilterType removeId();
}