org.jboss.shrinkwrap.descriptor.api.facesconfig21.FacesConfigConverterType Maven / Gradle / Ivy
package org.jboss.shrinkwrap.descriptor.api.facesconfig21;
import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.facesconfig21.FacesConfigAttributeType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig21.FacesConfigPropertyType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.IconType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig.*;
import org.jboss.shrinkwrap.descriptor.api.facesconfig.JavaeeFacesConfigConverterCommonType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig21.FacesConfigAttributeType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig21.FacesConfigPropertyType;/**
* This interface defines the contract for the faces-config-converterType xsd type
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
* @author George Gastaldi
*/
public interface FacesConfigConverterType extends Child,
JavaeeFacesConfigConverterCommonType,
FacesConfigAttributeType>,
FacesConfigPropertyType>> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigConverterType 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 FacesConfigConverterType
*/
public FacesConfigConverterType description(String ... values);
/**
* Returns all description elements
* @return list of description
*/
public List getAllDescription();
/**
* Removes the description element
* @return the current instance of FacesConfigConverterType
*/
public FacesConfigConverterType removeAllDescription();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigConverterType 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 FacesConfigConverterType
*/
public FacesConfigConverterType 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 FacesConfigConverterType
*/
public FacesConfigConverterType removeAllDisplayName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigConverterType 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 FacesConfigConverterType removeAllIcon();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigConverterType ElementName: xsd:token ElementType : converter-id
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the converter-id element
* @param converterId the value for the element converter-id
* @return the current instance of FacesConfigConverterType
*/
public FacesConfigConverterType converterId(String converterId);
/**
* Returns the converter-id element
* @return the node defined for the element converter-id
*/
public String getConverterId();
/**
* Removes the converter-id element
* @return the current instance of FacesConfigConverterType
*/
public FacesConfigConverterType removeConverterId();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigConverterType ElementName: xsd:token ElementType : converter-for-class
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the converter-for-class element
* @param converterForClass the value for the element converter-for-class
* @return the current instance of FacesConfigConverterType
*/
public FacesConfigConverterType converterForClass(String converterForClass);
/**
* Returns the converter-for-class element
* @return the node defined for the element converter-for-class
*/
public String getConverterForClass();
/**
* Removes the converter-for-class element
* @return the current instance of FacesConfigConverterType
*/
public FacesConfigConverterType removeConverterForClass();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigConverterType ElementName: xsd:token ElementType : converter-class
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the converter-class element
* @param converterClass the value for the element converter-class
* @return the current instance of FacesConfigConverterType
*/
public FacesConfigConverterType converterClass(String converterClass);
/**
* Returns the converter-class element
* @return the node defined for the element converter-class
*/
public String getConverterClass();
/**
* Removes the converter-class element
* @return the current instance of FacesConfigConverterType
*/
public FacesConfigConverterType removeConverterClass();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigConverterType ElementName: javaee:faces-config-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 FacesConfigAttributeType> getOrCreateAttribute();
/**
* Creates a new attribute element
* @return the new created instance of FacesConfigAttributeType>
*/
public FacesConfigAttributeType> createAttribute();
/**
* Returns all attribute elements
* @return list of attribute
*/
public List>> getAllAttribute();
/**
* Removes all attribute elements
* @return the current instance of FacesConfigAttributeType>
*/
public FacesConfigConverterType removeAllAttribute();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigConverterType ElementName: javaee:faces-config-propertyType ElementType : property
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new property element will be created and returned.
* Otherwise, the first existing property element will be returned.
* @return the instance defined for the element property
*/
public FacesConfigPropertyType> getOrCreateProperty();
/**
* Creates a new property element
* @return the new created instance of FacesConfigPropertyType>
*/
public FacesConfigPropertyType> createProperty();
/**
* Returns all property elements
* @return list of property
*/
public List>> getAllProperty();
/**
* Removes all property elements
* @return the current instance of FacesConfigPropertyType>
*/
public FacesConfigConverterType removeAllProperty();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigConverterType ElementName: javaee:faces-config-converter-extensionType ElementType : converter-extension
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the converter-extension element
* @return the current instance of FacesConfigConverterType
*/
public FacesConfigConverterType converterExtension();
/**
* Removes the converter-extension element
* @return the current instance of FacesConfigConverterType
*/
public Boolean isConverterExtension();
/**
* Removes the converter-extension element
* @return the current instance of FacesConfigConverterType
*/
public FacesConfigConverterType removeConverterExtension();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigConverterType 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 FacesConfigConverterType
*/
public FacesConfigConverterType 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 FacesConfigConverterType
*/
public FacesConfigConverterType removeId();
}