org.jboss.shrinkwrap.descriptor.api.validationMapping11.BeanType 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.validationMapping11; 

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.validationMapping11.ClassType;
import org.jboss.shrinkwrap.descriptor.api.validationMapping11.FieldType;
import org.jboss.shrinkwrap.descriptor.api.validationMapping11.GetterType;
import org.jboss.shrinkwrap.descriptor.api.validationMapping11.ConstructorType;
import org.jboss.shrinkwrap.descriptor.api.validationMapping11.MethodType;
import org.jboss.shrinkwrap.descriptor.api.validationMapping.*;
import org.jboss.shrinkwrap.descriptor.api.validationMapping.MapBeanCommonType;

import org.jboss.shrinkwrap.descriptor.api.validationMapping11.ClassType;
import org.jboss.shrinkwrap.descriptor.api.validationMapping11.FieldType;
import org.jboss.shrinkwrap.descriptor.api.validationMapping11.GetterType;/**
 * This interface defines the contract for the  beanType  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface BeanType extends Child, 
    MapBeanCommonType,
    ClassType>,
    FieldType>,
    GetterType>> { 

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: BeanType ElementName: map:classType ElementType : class
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

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

   /**
    * Removes the class element 
    * @return the current instance of BeanType 
    */
   public BeanType removeClazz();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: BeanType ElementName: map:fieldType ElementType : field
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

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

   /**
    * Creates a new field element 
    * @return the new created instance of FieldType> 
    */
   public FieldType> createField();

   /**
    * Returns all field elements
    * @return list of field 
    */
   public List>> getAllField();

   /**
    * Removes all field elements 
    * @return the current instance of FieldType> 
    */
   public BeanType removeAllField();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: BeanType ElementName: map:getterType ElementType : getter
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

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

   /**
    * Creates a new getter element 
    * @return the new created instance of GetterType> 
    */
   public GetterType> createGetter();

   /**
    * Returns all getter elements
    * @return list of getter 
    */
   public List>> getAllGetter();

   /**
    * Removes all getter elements 
    * @return the current instance of GetterType> 
    */
   public BeanType removeAllGetter();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: BeanType ElementName: map:constructorType ElementType : constructor
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

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

   /**
    * Creates a new constructor element 
    * @return the new created instance of ConstructorType> 
    */
   public ConstructorType> createConstructor();

   /**
    * Returns all constructor elements
    * @return list of constructor 
    */
   public List>> getAllConstructor();

   /**
    * Removes all constructor elements 
    * @return the current instance of ConstructorType> 
    */
   public BeanType removeAllConstructor();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: BeanType ElementName: map:methodType ElementType : method
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

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

   /**
    * Creates a new method element 
    * @return the new created instance of MethodType> 
    */
   public MethodType> createMethod();

   /**
    * Returns all method elements
    * @return list of method 
    */
   public List>> getAllMethod();

   /**
    * Removes all method elements 
    * @return the current instance of MethodType> 
    */
   public BeanType removeAllMethod();

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

   /**
    * Sets the class attribute
    * @param clazz the value for the attribute class 
    * @return the current instance of BeanType 
    */
   public BeanType clazz(String clazz);

   /**
    * Returns the class attribute
    * @return the value defined for the attribute class 
    */
   public String getClazz();

   /**
    * Removes the class attribute 
    * @return the current instance of BeanType 
    */
   public BeanType removeClazzAttr();

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