org.jboss.shrinkwrap.descriptor.api.javaee6.ListenerType Maven / Gradle / Ivy

package org.jboss.shrinkwrap.descriptor.api.javaee6; 

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.javaee6.IconType;
import org.jboss.shrinkwrap.descriptor.api.javaee.*;
/**
 * This interface defines the contract for the  listenerType  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface ListenerType extends Child, 
    JavaeeListenerCommonType> { 

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ListenerType 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 ListenerType 
    */
   public ListenerType description(String ... values);

   /**
    * Returns all description elements
    * @return list of description 
    */
   public List getAllDescription();

   /**
    * Removes the description element 
    * @return the current instance of ListenerType 
    */
   public ListenerType removeAllDescription();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ListenerType 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 ListenerType 
    */
   public ListenerType 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 ListenerType 
    */
   public ListenerType removeAllDisplayName();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ListenerType 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 ListenerType removeAllIcon();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ListenerType ElementName: xsd:token ElementType : listener-class
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the listener-class element
    * @param listenerClass the value for the element listener-class 
    * @return the current instance of ListenerType 
    */
   public ListenerType listenerClass(String listenerClass);

   /**
    * Returns the listener-class element
    * @return the node defined for the element listener-class 
    */
   public String getListenerClass();

   /**
    * Removes the listener-class element 
    * @return the current instance of ListenerType 
    */
   public ListenerType removeListenerClass();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ListenerType 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 ListenerType 
    */
   public ListenerType 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 ListenerType 
    */
   public ListenerType removeId();
}