org.jboss.shrinkwrap.descriptor.api.jobXML10.Properties Maven / Gradle / Ivy

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

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.jobXML10.Property;
import org.jboss.shrinkwrap.descriptor.api.jobXML.*;
import org.jboss.shrinkwrap.descriptor.api.jobXML.JslPropertiesCommType;

import org.jboss.shrinkwrap.descriptor.api.jobXML10.Property;/**
 * This interface defines the contract for the  Properties  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 */
public interface Properties extends Child, 
    JslPropertiesCommType,
    Property>> { 

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: Properties ElementName: jsl:Property 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 Property> getOrCreateProperty();

   /**
    * Creates a new property element 
    * @return the new created instance of Property> 
    */
   public Property> createProperty();

   /**
    * Returns all property elements
    * @return list of property 
    */
   public List>> getAllProperty();

   /**
    * Removes all property elements 
    * @return the current instance of Property> 
    */
   public Properties removeAllProperty();

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

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

   /**
    * Returns the partition attribute
    * @return the value defined for the attribute partition 
    */
   public String getPartition();

   /**
    * Removes the partition attribute 
    * @return the current instance of Properties 
    */
   public Properties removePartition();
}