org.jboss.shrinkwrap.descriptor.api.validationMapping10.ElementType Maven / Gradle / Ivy

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

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.validationMapping10.AnnotationType;
import org.jboss.shrinkwrap.descriptor.api.validationMapping.*;
import org.jboss.shrinkwrap.descriptor.api.validationMapping.MapElementCommonType;

import org.jboss.shrinkwrap.descriptor.api.validationMapping10.AnnotationType;/**
 * This interface defines the contract for the  elementType  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface ElementType extends Child, 
    MapElementCommonType,
    AnnotationType>> { 

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementType ElementName: text ElementType : elementType
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the body text for the element elementType 
    * @param elementType the value for the body text elementType 
    * @return the current instance of ElementType 
    */
   public ElementType text(String value);

   /**
    * Returns the body text of the element elementType 
    * @return the value defined for the text elementType 
    */
   public String getText();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementType ElementName: xsd:string ElementType : value
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Creates for all String objects representing value elements, 
    * a new value element 
    * @param values list of value objects 
    * @return the current instance of ElementType 
    */
   public ElementType value(String ... values);

   /**
    * Returns all value elements
    * @return list of value 
    */
   public List getAllValue();

   /**
    * Removes the value element 
    * @return the current instance of ElementType 
    */
   public ElementType removeAllValue();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementType ElementName: map:annotationType ElementType : annotation
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new annotation element will be created and returned.
    * Otherwise, the first existing annotation element will be returned.
    * @return the instance defined for the element annotation 
    */
   public AnnotationType> getOrCreateAnnotation();

   /**
    * Creates a new annotation element 
    * @return the new created instance of AnnotationType> 
    */
   public AnnotationType> createAnnotation();

   /**
    * Returns all annotation elements
    * @return list of annotation 
    */
   public List>> getAllAnnotation();

   /**
    * Removes all annotation elements 
    * @return the current instance of AnnotationType> 
    */
   public ElementType removeAllAnnotation();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementType ElementName: xsd:string ElementType : name
   // MaxOccurs: -  isGeneric: true   isAttribute: true isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the name attribute
    * @param name the value for the attribute name 
    * @return the current instance of ElementType 
    */
   public ElementType name(String name);

   /**
    * Returns the name attribute
    * @return the value defined for the attribute name 
    */
   public String getName();

   /**
    * Removes the name attribute 
    * @return the current instance of ElementType 
    */
   public ElementType removeName();
}