org.jboss.shrinkwrap.descriptor.api.connector10.ConnectorDescriptor Maven / Gradle / Ivy
Show all versions of shrinkwrap-descriptors-api-javaee Show documentation
package org.jboss.shrinkwrap.descriptor.api.connector10;
import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.connector10.License;
import org.jboss.shrinkwrap.descriptor.api.connector10.Icon;
import org.jboss.shrinkwrap.descriptor.api.connector10.Resourceadapter;
import org.jboss.shrinkwrap.descriptor.api.Descriptor;
import org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace;
/**
*
* This deployment descriptor provides the functionalities as described in the specification
*
* Example:
*
*
* ConnectorDescriptor descriptor = Descriptors.create(ConnectorDescriptor.class);
*
*
*
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
* @author George Gastaldi
*/
public interface ConnectorDescriptor extends Descriptor, DescriptorNamespace {
// --------------------------------------------------------------------------------------------------------||
// ClassName: ConnectorDescriptor ElementName: xsd:string ElementType : spec-version
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the spec-version element
* @param specVersion the value for the element spec-version
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor specVersion(String specVersion);
/**
* Returns the spec-version element
* @return the node defined for the element spec-version
*/
public String getSpecVersion();
/**
* Removes the spec-version element
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor removeSpecVersion();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ConnectorDescriptor ElementName: j2ee:license ElementType : license
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new license element with the given value will be created.
* Otherwise, the existing license element will be returned.
* @return a new or existing instance of License
*/
public License getOrCreateLicense();
/**
* Removes the license element
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor removeLicense();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ConnectorDescriptor ElementName: xsd:string ElementType : display-name
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the display-name element
* @param displayName the value for the element display-name
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor displayName(String displayName);
/**
* Returns the display-name element
* @return the node defined for the element display-name
*/
public String getDisplayName();
/**
* Removes the display-name element
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor removeDisplayName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ConnectorDescriptor ElementName: j2ee:icon ElementType : icon
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new icon element with the given value will be created.
* Otherwise, the existing icon element will be returned.
* @return a new or existing instance of Icon
*/
public Icon getOrCreateIcon();
/**
* Removes the icon element
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor removeIcon();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ConnectorDescriptor ElementName: xsd:string ElementType : description
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the description element
* @param description the value for the element description
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor description(String description);
/**
* Returns the description element
* @return the node defined for the element description
*/
public String getDescription();
/**
* Removes the description element
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor removeDescription();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ConnectorDescriptor ElementName: xsd:string ElementType : vendor-name
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the vendor-name element
* @param vendorName the value for the element vendor-name
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor vendorName(String vendorName);
/**
* Returns the vendor-name element
* @return the node defined for the element vendor-name
*/
public String getVendorName();
/**
* Removes the vendor-name element
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor removeVendorName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ConnectorDescriptor ElementName: xsd:string ElementType : eis-type
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the eis-type element
* @param eisType the value for the element eis-type
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor eisType(String eisType);
/**
* Returns the eis-type element
* @return the node defined for the element eis-type
*/
public String getEisType();
/**
* Removes the eis-type element
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor removeEisType();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ConnectorDescriptor ElementName: xsd:string ElementType : version
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the version element
* @param version the value for the element version
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor version(String version);
/**
* Returns the version element
* @return the node defined for the element version
*/
public String getVersion();
/**
* Removes the version element
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor removeVersion();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ConnectorDescriptor ElementName: j2ee:resourceadapter ElementType : resourceadapter
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new resourceadapter element with the given value will be created.
* Otherwise, the existing resourceadapter element will be returned.
* @return a new or existing instance of Resourceadapter
*/
public Resourceadapter getOrCreateResourceadapter();
/**
* Removes the resourceadapter element
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor removeResourceadapter();
}