org.jboss.shrinkwrap.descriptor.api.validationMapping11.MethodType Maven / Gradle / Ivy

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

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.validationMapping11.ParameterType;
import org.jboss.shrinkwrap.descriptor.api.validationMapping11.CrossParameterType;
import org.jboss.shrinkwrap.descriptor.api.validationMapping11.ReturnValueType;
import org.jboss.shrinkwrap.descriptor.api.validationMapping.*;
import org.jboss.shrinkwrap.descriptor.api.validationMapping.MapMethodCommonType;

import org.jboss.shrinkwrap.descriptor.api.validationMapping11.ParameterType;
import org.jboss.shrinkwrap.descriptor.api.validationMapping11.CrossParameterType;
import org.jboss.shrinkwrap.descriptor.api.validationMapping11.ReturnValueType;/**
 * This interface defines the contract for the  methodType  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface MethodType extends Child, 
    MapMethodCommonType,
    ParameterType>,
    CrossParameterType>,
    ReturnValueType>> { 

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: MethodType ElementName: map:parameterType ElementType : parameter
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

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

   /**
    * Creates a new parameter element 
    * @return the new created instance of ParameterType> 
    */
   public ParameterType> createParameter();

   /**
    * Returns all parameter elements
    * @return list of parameter 
    */
   public List>> getAllParameter();

   /**
    * Removes all parameter elements 
    * @return the current instance of ParameterType> 
    */
   public MethodType removeAllParameter();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: MethodType ElementName: map:crossParameterType ElementType : cross-parameter
   // MaxOccurs: -1  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new cross-parameter element with the given value will be created.
    * Otherwise, the existing cross-parameter element will be returned.
    * @return  a new or existing instance of CrossParameterType> 
    */
   public CrossParameterType> getOrCreateCrossParameter();

   /**
    * Removes the cross-parameter element 
    * @return the current instance of MethodType 
    */
   public MethodType removeCrossParameter();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: MethodType ElementName: map:returnValueType ElementType : return-value
   // MaxOccurs: -1  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new return-value element with the given value will be created.
    * Otherwise, the existing return-value element will be returned.
    * @return  a new or existing instance of ReturnValueType> 
    */
   public ReturnValueType> getOrCreateReturnValue();

   /**
    * Removes the return-value element 
    * @return the current instance of MethodType 
    */
   public MethodType removeReturnValue();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: MethodType 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 MethodType 
    */
   public MethodType 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 MethodType 
    */
   public MethodType removeName();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: MethodType ElementName: xsd:boolean ElementType : ignore-annotations
   // MaxOccurs: -  isGeneric: true   isAttribute: true isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the ignore-annotations attribute
    * @param ignoreAnnotations the value for the attribute ignore-annotations 
    * @return the current instance of MethodType 
    */
   public MethodType ignoreAnnotations(Boolean ignoreAnnotations);

   /**
    * Returns the ignore-annotations attribute
    * @return the value defined for the attribute ignore-annotations 
    */
public Boolean isIgnoreAnnotations();

   /**
    * Removes the ignore-annotations attribute 
    * @return the current instance of MethodType 
    */
   public MethodType removeIgnoreAnnotations();
}