org.jboss.shrinkwrap.descriptor.api.connector15
Interface ConnectorDescriptor

All Superinterfaces:

Descriptor, DescriptorNamespace<ConnectorDescriptor>

public interface ConnectorDescriptor
extends Descriptor, DescriptorNamespace<ConnectorDescriptor>

This deployment descriptor provides the functionalities as described in the specification

Example:

ConnectorDescriptor descriptor = Descriptors.create(ConnectorDescriptor.class);

Since:

Generation date :2012-05-09T23:45:02.086-07:00

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

IconType<ConnectorDescriptor>	createIcon() Creates a new icon element
ConnectorDescriptor	description(String... values) Creates for all String objects representing description elements, a new description element
ConnectorDescriptor	displayName(String... values) Creates for all String objects representing display-name elements, a new display-name element
ConnectorDescriptor	eisType(String eisType) Sets the eis-type element
List<String>	getAllDescription() Returns all description elements
List<String>	getAllDisplayName() Returns all display-name elements
List<IconType<ConnectorDescriptor>>	getAllIcon() Returns all icon elements
String	getEisType() Returns the eis-type element
IconType<ConnectorDescriptor>	getOrCreateIcon() If not already created, a new icon element will be created and returned.
LicenseType<ConnectorDescriptor>	getOrCreateLicense() If not already created, a new license element with the given value will be created.
ResourceadapterType<ConnectorDescriptor>	getOrCreateResourceadapter() If not already created, a new resourceadapter element with the given value will be created.
String	getResourceadapterVersion() Returns the resourceadapter-version element
String	getVendorName() Returns the vendor-name element
String	getVersion() Returns the version attribute
ConnectorDescriptor	removeAllDescription() Removes the description element
ConnectorDescriptor	removeAllDisplayName() Removes the display-name element
ConnectorDescriptor	removeAllIcon() Removes all icon elements
ConnectorDescriptor	removeEisType() Removes the eis-type element
ConnectorDescriptor	removeLicense() Removes the license element
ConnectorDescriptor	removeResourceadapter() Removes the resourceadapter element
ConnectorDescriptor	removeResourceadapterVersion() Removes the resourceadapter-version element
ConnectorDescriptor	removeVendorName() Removes the vendor-name element
ConnectorDescriptor	removeVersion() Removes the version attribute
ConnectorDescriptor	resourceadapterVersion(String resourceadapterVersion) Sets the resourceadapter-version element
ConnectorDescriptor	vendorName(String vendorName) Sets the vendor-name element
ConnectorDescriptor	version(String version) Sets the version attribute

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Descriptor

exportAsString, exportTo, getDescriptorName

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace

addDefaultNamespaces, addNamespace, getNamespaces, removeAllNamespaces

Method Detail

description

ConnectorDescriptor description(String... values)

Creates for all String objects representing description elements, a new description element

Parameters:

values - list of description objects

Returns:

the current instance of ConnectorDescriptor

getAllDescription

List<String> getAllDescription()

Returns all description elements

Returns:

list of description

removeAllDescription

ConnectorDescriptor removeAllDescription()

Removes the description element

Returns:

the current instance of ConnectorDescriptor

displayName

ConnectorDescriptor displayName(String... values)

Creates for all String objects representing display-name elements, a new display-name element

Parameters:

values - list of display-name objects

Returns:

the current instance of ConnectorDescriptor

getAllDisplayName

List<String> getAllDisplayName()

Returns all display-name elements

Returns:

list of display-name

removeAllDisplayName

ConnectorDescriptor removeAllDisplayName()

Removes the display-name element

Returns:

the current instance of ConnectorDescriptor

getOrCreateIcon

IconType<ConnectorDescriptor> getOrCreateIcon()

If not already created, a new icon element will be created and returned. Otherwise, the first existing icon element will be returned.

Returns:

the instance defined for the element icon

createIcon

IconType<ConnectorDescriptor> createIcon()

Creates a new icon element

Returns:

the new created instance of IconType

getAllIcon

List<IconType<ConnectorDescriptor>> getAllIcon()

Returns all icon elements

Returns:

list of icon

removeAllIcon

ConnectorDescriptor removeAllIcon()

Removes all icon elements

Returns:

the current instance of IconType

vendorName

ConnectorDescriptor vendorName(String vendorName)

Sets the vendor-name element

Parameters:

vendorName - the value for the element vendor-name

Returns:

the current instance of ConnectorDescriptor

getVendorName

String getVendorName()

Returns the vendor-name element

Returns:

the node defined for the element vendor-name

removeVendorName

ConnectorDescriptor removeVendorName()

Removes the vendor-name element

Returns:

the current instance of ConnectorDescriptor

eisType

ConnectorDescriptor eisType(String eisType)

Sets the eis-type element

Parameters:

eisType - the value for the element eis-type

Returns:

the current instance of ConnectorDescriptor

getEisType

String getEisType()

Returns the eis-type element

Returns:

the node defined for the element eis-type

removeEisType

ConnectorDescriptor removeEisType()

Removes the eis-type element

Returns:

the current instance of ConnectorDescriptor

resourceadapterVersion

ConnectorDescriptor resourceadapterVersion(String resourceadapterVersion)

Sets the resourceadapter-version element

Parameters:

resourceadapterVersion - the value for the element resourceadapter-version

Returns:

the current instance of ConnectorDescriptor

getResourceadapterVersion

String getResourceadapterVersion()

Returns the resourceadapter-version element

Returns:

the node defined for the element resourceadapter-version

removeResourceadapterVersion

ConnectorDescriptor removeResourceadapterVersion()

Removes the resourceadapter-version element

Returns:

the current instance of ConnectorDescriptor

getOrCreateLicense

LicenseType<ConnectorDescriptor> getOrCreateLicense()

If not already created, a new license element with the given value will be created. Otherwise, the existing license element will be returned.

Returns:

a new or existing instance of LicenseType

removeLicense

ConnectorDescriptor removeLicense()

Removes the license element

Returns:

the current instance of ConnectorDescriptor

getOrCreateResourceadapter

ResourceadapterType<ConnectorDescriptor> getOrCreateResourceadapter()

If not already created, a new resourceadapter element with the given value will be created. Otherwise, the existing resourceadapter element will be returned.

Returns:

a new or existing instance of ResourceadapterType

removeResourceadapter

ConnectorDescriptor removeResourceadapter()

Removes the resourceadapter element

Returns:

the current instance of ConnectorDescriptor

version

ConnectorDescriptor version(String version)

Sets the version attribute

Parameters:

version - the value for the attribute version

Returns:

the current instance of ConnectorDescriptor

getVersion

String getVersion()

Returns the version attribute

Returns:

the value defined for the attribute version

removeVersion

ConnectorDescriptor removeVersion()

Removes the version attribute

Returns:

the current instance of ConnectorDescriptor