org.jboss.shrinkwrap.descriptor.api.javaee5.EnvEntryType Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
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.javaee5; 

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.javaee5.EnvEntryTypeValuesType;
import org.jboss.shrinkwrap.descriptor.api.javaee5.InjectionTargetType;
import org.jboss.shrinkwrap.descriptor.api.javaee.*;
/**
 * This interface defines the contract for the  env-entryType  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface EnvEntryType extends Child, 
    JavaeeEnvEntryCommonType> { 

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

   /**
    * Sets the mapped-name element
    * @param mappedName the value for the element mapped-name 
    * @return the current instance of EnvEntryType 
    */
   public EnvEntryType mappedName(String mappedName);

   /**
    * Returns the mapped-name element
    * @return the node defined for the element mapped-name 
    */
   public String getMappedName();

   /**
    * Removes the mapped-name element 
    * @return the current instance of EnvEntryType 
    */
   public EnvEntryType removeMappedName();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: EnvEntryType ElementName: javaee:injection-targetType ElementType : injection-target
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new injection-target element will be created and returned.
    * Otherwise, the first existing injection-target element will be returned.
    * @return the instance defined for the element injection-target 
    */
   public InjectionTargetType> getOrCreateInjectionTarget();

   /**
    * Creates a new injection-target element 
    * @return the new created instance of InjectionTargetType> 
    */
   public InjectionTargetType> createInjectionTarget();

   /**
    * Returns all injection-target elements
    * @return list of injection-target 
    */
   public List>> getAllInjectionTarget();

   /**
    * Removes all injection-target elements 
    * @return the current instance of InjectionTargetType> 
    */
   public EnvEntryType removeAllInjectionTarget();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: EnvEntryType 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 EnvEntryType 
    */
   public EnvEntryType description(String ... values);

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

   /**
    * Removes the description element 
    * @return the current instance of EnvEntryType 
    */
   public EnvEntryType removeAllDescription();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: EnvEntryType ElementName: xsd:token ElementType : env-entry-name
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the env-entry-name element
    * @param envEntryName the value for the element env-entry-name 
    * @return the current instance of EnvEntryType 
    */
   public EnvEntryType envEntryName(String envEntryName);

   /**
    * Returns the env-entry-name element
    * @return the node defined for the element env-entry-name 
    */
   public String getEnvEntryName();

   /**
    * Removes the env-entry-name element 
    * @return the current instance of EnvEntryType 
    */
   public EnvEntryType removeEnvEntryName();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: EnvEntryType ElementName: javaee:env-entry-type-valuesType ElementType : env-entry-type
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: true isDataType: false
   // --------------------------------------------------------------------------------------------------------||
   /**
    * Sets the env-entry-type element
    * @param envEntryType the value for the element env-entry-type 
    * @return the current instance of EnvEntryType 
    */
   public EnvEntryType envEntryType(EnvEntryTypeValuesType envEntryType);
   /**
    * Sets the env-entry-type element
    * @param envEntryType the value for the element env-entry-type 
    * @return the current instance of EnvEntryType 
    */
   public EnvEntryType envEntryType(String envEntryType);

   /**
    * Returns the env-entry-type element
    * @return the value found for the element env-entry-type 
    */
   public EnvEntryTypeValuesType getEnvEntryType();

   /**
    * Returns the env-entry-type element
    * @return the value found for the element env-entry-type 
    */
   public String  getEnvEntryTypeAsString();

   /**
    * Removes the env-entry-type attribute 
    * @return the current instance of EnvEntryType 
    */
   public EnvEntryType removeEnvEntryType();

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

   /**
    * Sets the env-entry-value element
    * @param envEntryValue the value for the element env-entry-value 
    * @return the current instance of EnvEntryType 
    */
   public EnvEntryType envEntryValue(String envEntryValue);

   /**
    * Returns the env-entry-value element
    * @return the node defined for the element env-entry-value 
    */
   public String getEnvEntryValue();

   /**
    * Removes the env-entry-value element 
    * @return the current instance of EnvEntryType 
    */
   public EnvEntryType removeEnvEntryValue();

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