org.jboss.shrinkwrap.descriptor.api.ejbjar30.EjbJarDescriptor Maven / Gradle / Ivy
package org.jboss.shrinkwrap.descriptor.api.ejbjar30;
import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.ejbjar30.EnterpriseBeansType;
import org.jboss.shrinkwrap.descriptor.api.ejbjar30.InterceptorsType;
import org.jboss.shrinkwrap.descriptor.api.ejbjar30.RelationshipsType;
import org.jboss.shrinkwrap.descriptor.api.ejbjar30.AssemblyDescriptorType;
import org.jboss.shrinkwrap.descriptor.api.javaee5.IconType;
import org.jboss.shrinkwrap.descriptor.api.Descriptor;
import org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace;
import org.jboss.shrinkwrap.descriptor.api.ejbjar.*;
/**
*
* This deployment descriptor provides the functionalities as described in the specification
*
* Example:
*
*
* EjbJarDescriptor descriptor = Descriptors.create(EjbJarDescriptor.class);
*
*
*
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
* @author George Gastaldi
*/
public interface EjbJarDescriptor extends Descriptor, DescriptorNamespace,
EjbJarCommonDescriptor> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: EjbJarDescriptor ElementName: xsd:string ElementType : description
// MaxOccurs: -unbounded isGeneric: false 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 EjbJarDescriptor
*/
public EjbJarDescriptor description(String ... values);
/**
* Returns all description elements
* @return list of description
*/
public List getAllDescription();
/**
* Removes the description element
* @return the current instance of EjbJarDescriptor
*/
public EjbJarDescriptor removeAllDescription();
// --------------------------------------------------------------------------------------------------------||
// ClassName: EjbJarDescriptor ElementName: xsd:token ElementType : display-name
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Creates for all String objects representing display-name elements,
* a new display-name element
* @param values list of display-name objects
* @return the current instance of EjbJarDescriptor
*/
public EjbJarDescriptor displayName(String ... values);
/**
* Returns all display-name elements
* @return list of display-name
*/
public List getAllDisplayName();
/**
* Removes the display-name element
* @return the current instance of EjbJarDescriptor
*/
public EjbJarDescriptor removeAllDisplayName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: EjbJarDescriptor ElementName: javaee:iconType ElementType : icon
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new icon element will be created and returned.
* Otherwise, the first existing icon element will be returned.
* @return the instance defined for the element icon
*/
public IconType getOrCreateIcon();
/**
* Creates a new icon element
* @return the new created instance of IconType
*/
public IconType createIcon();
/**
* Returns all icon elements
* @return list of icon
*/
public List> getAllIcon();
/**
* Removes all icon elements
* @return the current instance of IconType
*/
public EjbJarDescriptor removeAllIcon();
// --------------------------------------------------------------------------------------------------------||
// ClassName: EjbJarDescriptor ElementName: javaee:enterprise-beansType ElementType : enterprise-beans
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new enterprise-beans element with the given value will be created.
* Otherwise, the existing enterprise-beans element will be returned.
* @return a new or existing instance of EnterpriseBeansType
*/
public EnterpriseBeansType getOrCreateEnterpriseBeans();
/**
* Removes the enterprise-beans element
* @return the current instance of EjbJarDescriptor
*/
public EjbJarDescriptor removeEnterpriseBeans();
// --------------------------------------------------------------------------------------------------------||
// ClassName: EjbJarDescriptor ElementName: javaee:interceptorsType ElementType : interceptors
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new interceptors element with the given value will be created.
* Otherwise, the existing interceptors element will be returned.
* @return a new or existing instance of InterceptorsType
*/
public InterceptorsType getOrCreateInterceptors();
/**
* Removes the interceptors element
* @return the current instance of EjbJarDescriptor
*/
public EjbJarDescriptor removeInterceptors();
// --------------------------------------------------------------------------------------------------------||
// ClassName: EjbJarDescriptor ElementName: javaee:relationshipsType ElementType : relationships
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new relationships element with the given value will be created.
* Otherwise, the existing relationships element will be returned.
* @return a new or existing instance of RelationshipsType
*/
public RelationshipsType getOrCreateRelationships();
/**
* Removes the relationships element
* @return the current instance of EjbJarDescriptor
*/
public EjbJarDescriptor removeRelationships();
// --------------------------------------------------------------------------------------------------------||
// ClassName: EjbJarDescriptor ElementName: javaee:assembly-descriptorType ElementType : assembly-descriptor
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new assembly-descriptor element with the given value will be created.
* Otherwise, the existing assembly-descriptor element will be returned.
* @return a new or existing instance of AssemblyDescriptorType
*/
public AssemblyDescriptorType getOrCreateAssemblyDescriptor();
/**
* Removes the assembly-descriptor element
* @return the current instance of EjbJarDescriptor
*/
public EjbJarDescriptor removeAssemblyDescriptor();
// --------------------------------------------------------------------------------------------------------||
// ClassName: EjbJarDescriptor ElementName: xsd:token ElementType : ejb-client-jar
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the ejb-client-jar element
* @param ejbClientJar the value for the element ejb-client-jar
* @return the current instance of EjbJarDescriptor
*/
public EjbJarDescriptor ejbClientJar(String ejbClientJar);
/**
* Returns the ejb-client-jar element
* @return the node defined for the element ejb-client-jar
*/
public String getEjbClientJar();
/**
* Removes the ejb-client-jar element
* @return the current instance of EjbJarDescriptor
*/
public EjbJarDescriptor removeEjbClientJar();
// --------------------------------------------------------------------------------------------------------||
// ClassName: EjbJarDescriptor ElementName: xsd:token ElementType : version
// MaxOccurs: - isGeneric: false isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
public static final String VERSION = "3.0";
/**
* Sets the version attribute
* @param version the value for the attribute version
* @return the current instance of EjbJarDescriptor
*/
public EjbJarDescriptor version(String version);
/**
* Returns the version attribute
* @return the value defined for the attribute version
*/
public String getVersion();
/**
* Removes the version attribute
* @return the current instance of EjbJarDescriptor
*/
public EjbJarDescriptor removeVersion();
// --------------------------------------------------------------------------------------------------------||
// ClassName: EjbJarDescriptor ElementName: xsd:boolean ElementType : metadata-complete
// MaxOccurs: - isGeneric: false isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the metadata-complete attribute
* @param metadataComplete the value for the attribute metadata-complete
* @return the current instance of EjbJarDescriptor
*/
public EjbJarDescriptor metadataComplete(Boolean metadataComplete);
/**
* Returns the metadata-complete attribute
* @return the value defined for the attribute metadata-complete
*/
public Boolean isMetadataComplete();
/**
* Removes the metadata-complete attribute
* @return the current instance of EjbJarDescriptor
*/
public EjbJarDescriptor removeMetadataComplete();
// --------------------------------------------------------------------------------------------------------||
// ClassName: EjbJarDescriptor ElementName: xsd:ID ElementType : id
// MaxOccurs: - isGeneric: false isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the id attribute
* @param id the value for the attribute id
* @return the current instance of EjbJarDescriptor
*/
public EjbJarDescriptor 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 EjbJarDescriptor
*/
public EjbJarDescriptor removeId();
}