org.jboss.shrinkwrap.descriptor.impl.connector17

Class ConnectorDescriptorImpl

java.lang.Object

org.jboss.shrinkwrap.descriptor.spi.DescriptorImplBase<org.jboss.shrinkwrap.descriptor.spi.node.NodeDescriptor>

org.jboss.shrinkwrap.descriptor.spi.node.NodeDescriptorImplBase

org.jboss.shrinkwrap.descriptor.impl.connector17.ConnectorDescriptorImpl

All Implemented Interfaces:

ConnectorDescriptor, org.jboss.shrinkwrap.descriptor.api.Descriptor, org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace<ConnectorDescriptor>, org.jboss.shrinkwrap.descriptor.spi.node.NodeDescriptor

public class ConnectorDescriptorImpl
extends org.jboss.shrinkwrap.descriptor.spi.node.NodeDescriptorImplBase
implements org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace<ConnectorDescriptor>, ConnectorDescriptor

This deployment descriptor provides the functionalities as described in the specification

Example:

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

Field Summary

Fields inherited from interface org.jboss.shrinkwrap.descriptor.api.connector17.ConnectorDescriptor

VERSION

Constructor Summary

Constructors

Constructor and Description
ConnectorDescriptorImpl(String descriptorName)
ConnectorDescriptorImpl(String descriptorName, org.jboss.shrinkwrap.descriptor.spi.node.Node node)

Method Summary

Modifier and Type	Method and Description
ConnectorDescriptor	addDefaultNamespaces() Adds the default namespaces as defined in the specification
ConnectorDescriptor	addNamespace(String name, String value) Adds a new namespace
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
List<String>	getAllRequiredWorkContext() Returns all required-work-context elements
String	getEisType() Returns the eis-type element
String	getId() Returns the id attribute
String	getModuleName() Returns the module-name element
List<String>	getNamespaces() Returns all defined namespaces.
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
org.jboss.shrinkwrap.descriptor.spi.node.Node	getRootNode()
String	getVendorName() Returns the vendor-name element
String	getVersion() Returns the version attribute
ConnectorDescriptor	id(String id) Sets the id attribute
Boolean	isMetadataComplete() Returns the metadata-complete attribute
ConnectorDescriptor	metadataComplete(Boolean metadataComplete) Sets the metadata-complete attribute
ConnectorDescriptor	moduleName(String moduleName) Sets the module-name element
ConnectorDescriptor	removeAllDescription() Removes the description element
ConnectorDescriptor	removeAllDisplayName() Removes the display-name element
ConnectorDescriptor	removeAllIcon() Removes all icon elements
ConnectorDescriptor	removeAllNamespaces() Removes all existing namespaces.
ConnectorDescriptor	removeAllRequiredWorkContext() Removes the required-work-context element
ConnectorDescriptor	removeEisType() Removes the eis-type element
ConnectorDescriptor	removeId() Removes the id attribute
ConnectorDescriptor	removeLicense() Removes the license element
ConnectorDescriptor	removeMetadataComplete() Removes the metadata-complete attribute
ConnectorDescriptor	removeModuleName() Removes the module-name 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	requiredWorkContext(String... values) Creates for all String objects representing required-work-context elements, a new required-work-context element
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 class org.jboss.shrinkwrap.descriptor.spi.node.NodeDescriptorImplBase

exportTo, getExporter

Methods inherited from class org.jboss.shrinkwrap.descriptor.spi.DescriptorImplBase

exportAsString, getDescriptorName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

exportAsString, exportTo, getDescriptorName

Constructor Detail

ConnectorDescriptorImpl

public ConnectorDescriptorImpl(String descriptorName)

ConnectorDescriptorImpl

public ConnectorDescriptorImpl(String descriptorName,
                               org.jboss.shrinkwrap.descriptor.spi.node.Node node)

Method Detail

getRootNode

public org.jboss.shrinkwrap.descriptor.spi.node.Node getRootNode()

Specified by:

getRootNode in interface org.jboss.shrinkwrap.descriptor.spi.node.NodeDescriptor

addDefaultNamespaces

public ConnectorDescriptor addDefaultNamespaces()

Adds the default namespaces as defined in the specification

Specified by:

addDefaultNamespaces in interface org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace<ConnectorDescriptor>

Returns:

the current instance of ConnectorDescriptor

addNamespace

public ConnectorDescriptor addNamespace(String name,
                                        String value)

Adds a new namespace

Specified by:

addNamespace in interface org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace<ConnectorDescriptor>

Returns:

the current instance of ConnectorDescriptor

getNamespaces

public List<String> getNamespaces()

Returns all defined namespaces.

Specified by:

getNamespaces in interface org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace<ConnectorDescriptor>

Returns:

all defined namespaces

removeAllNamespaces

public ConnectorDescriptor removeAllNamespaces()

Removes all existing namespaces.

Specified by:

removeAllNamespaces in interface org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace<ConnectorDescriptor>

Returns:

the current instance of ConnectorDescriptor

moduleName

public ConnectorDescriptor moduleName(String moduleName)

Sets the module-name element

Specified by:

moduleName in interface ConnectorDescriptor

Parameters:

moduleName - the value for the element module-name

Returns:

the current instance of ConnectorDescriptor

getModuleName

public String getModuleName()

Returns the module-name element

Specified by:

getModuleName in interface ConnectorDescriptor

Returns:

the node defined for the element module-name

removeModuleName

public ConnectorDescriptor removeModuleName()

Removes the module-name element

Specified by:

removeModuleName in interface ConnectorDescriptor

Returns:

the current instance of ConnectorDescriptor

vendorName

public ConnectorDescriptor vendorName(String vendorName)

Sets the vendor-name element

Specified by:

vendorName in interface ConnectorDescriptor

Parameters:

vendorName - the value for the element vendor-name

Returns:

the current instance of ConnectorDescriptor

getVendorName

public String getVendorName()

Returns the vendor-name element

Specified by:

getVendorName in interface ConnectorDescriptor

Returns:

the node defined for the element vendor-name

removeVendorName

public ConnectorDescriptor removeVendorName()

Removes the vendor-name element

Specified by:

removeVendorName in interface ConnectorDescriptor

Returns:

the current instance of ConnectorDescriptor

eisType

public ConnectorDescriptor eisType(String eisType)

Sets the eis-type element

Specified by:

eisType in interface ConnectorDescriptor

Parameters:

eisType - the value for the element eis-type

Returns:

the current instance of ConnectorDescriptor

getEisType

public String getEisType()

Returns the eis-type element

Specified by:

getEisType in interface ConnectorDescriptor

Returns:

the node defined for the element eis-type

removeEisType

public ConnectorDescriptor removeEisType()

Removes the eis-type element

Specified by:

removeEisType in interface ConnectorDescriptor

Returns:

the current instance of ConnectorDescriptor

resourceadapterVersion

public ConnectorDescriptor resourceadapterVersion(String resourceadapterVersion)

Sets the resourceadapter-version element

Specified by:

resourceadapterVersion in interface ConnectorDescriptor

Parameters:

resourceadapterVersion - the value for the element resourceadapter-version

Returns:

the current instance of ConnectorDescriptor

getResourceadapterVersion

public String getResourceadapterVersion()

Returns the resourceadapter-version element

Specified by:

getResourceadapterVersion in interface ConnectorDescriptor

Returns:

the node defined for the element resourceadapter-version

removeResourceadapterVersion

public ConnectorDescriptor removeResourceadapterVersion()

Removes the resourceadapter-version element

Specified by:

removeResourceadapterVersion in interface ConnectorDescriptor

Returns:

the current instance of ConnectorDescriptor

getOrCreateLicense

public 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.

Specified by:

getOrCreateLicense in interface ConnectorDescriptor

Returns:

a new or existing instance of LicenseType

removeLicense

public ConnectorDescriptor removeLicense()

Removes the license element

Specified by:

removeLicense in interface ConnectorDescriptor

Returns:

the current instance of ConnectorDescriptor

getOrCreateResourceadapter

public 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.

Specified by:

getOrCreateResourceadapter in interface ConnectorDescriptor

Returns:

a new or existing instance of ResourceadapterType

removeResourceadapter

public ConnectorDescriptor removeResourceadapter()

Removes the resourceadapter element

Specified by:

removeResourceadapter in interface ConnectorDescriptor

Returns:

the current instance of ConnectorDescriptor

requiredWorkContext

public ConnectorDescriptor requiredWorkContext(String... values)

Creates for all String objects representing required-work-context elements, a new required-work-context element

Specified by:

requiredWorkContext in interface ConnectorDescriptor

Parameters:

values - list of required-work-context objects

Returns:

the current instance of ConnectorDescriptor

getAllRequiredWorkContext

public List<String> getAllRequiredWorkContext()

Returns all required-work-context elements

Specified by:

getAllRequiredWorkContext in interface ConnectorDescriptor

Returns:

list of required-work-context

removeAllRequiredWorkContext

public ConnectorDescriptor removeAllRequiredWorkContext()

Removes the required-work-context element

Specified by:

removeAllRequiredWorkContext in interface ConnectorDescriptor

Returns:

the current instance of ConnectorDescriptor

version

public ConnectorDescriptor version(String version)

Sets the version attribute

Specified by:

version in interface ConnectorDescriptor

Parameters:

version - the value for the attribute version

Returns:

the current instance of ConnectorDescriptor

getVersion

public String getVersion()

Returns the version attribute

Specified by:

getVersion in interface ConnectorDescriptor

Returns:

the value defined for the attribute version

removeVersion

public ConnectorDescriptor removeVersion()

Removes the version attribute

Specified by:

removeVersion in interface ConnectorDescriptor

Returns:

the current instance of ConnectorDescriptor

metadataComplete

public ConnectorDescriptor metadataComplete(Boolean metadataComplete)

Sets the metadata-complete attribute

Specified by:

metadataComplete in interface ConnectorDescriptor

Parameters:

metadataComplete - the value for the attribute metadata-complete

Returns:

the current instance of ConnectorDescriptor

isMetadataComplete

public Boolean isMetadataComplete()

Returns the metadata-complete attribute

Specified by:

isMetadataComplete in interface ConnectorDescriptor

Returns:

the value defined for the attribute metadata-complete

removeMetadataComplete

public ConnectorDescriptor removeMetadataComplete()

Removes the metadata-complete attribute

Specified by:

removeMetadataComplete in interface ConnectorDescriptor

Returns:

the current instance of ConnectorDescriptor

id

public ConnectorDescriptor id(String id)

Sets the id attribute

Specified by:

id in interface ConnectorDescriptor

Parameters:

id - the value for the attribute id

Returns:

the current instance of ConnectorDescriptor

getId

public String getId()

Returns the id attribute

Specified by:

getId in interface ConnectorDescriptor

Returns:

the value defined for the attribute id

removeId

public ConnectorDescriptor removeId()

Removes the id attribute

Specified by:

removeId in interface ConnectorDescriptor

Returns:

the current instance of ConnectorDescriptor

description

public ConnectorDescriptor description(String... values)

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

Specified by:

description in interface ConnectorDescriptor

Parameters:

values - list of description objects

Returns:

the current instance of ConnectorDescriptor

getAllDescription

public List<String> getAllDescription()

Returns all description elements

Specified by:

getAllDescription in interface ConnectorDescriptor

Returns:

list of description

removeAllDescription

public ConnectorDescriptor removeAllDescription()

Removes the description element

Specified by:

removeAllDescription in interface ConnectorDescriptor

Returns:

the current instance of ConnectorDescriptor

displayName

public ConnectorDescriptor displayName(String... values)

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

Specified by:

displayName in interface ConnectorDescriptor

Parameters:

values - list of display-name objects

Returns:

the current instance of ConnectorDescriptor

getAllDisplayName

public List<String> getAllDisplayName()

Returns all display-name elements

Specified by:

getAllDisplayName in interface ConnectorDescriptor

Returns:

list of display-name

removeAllDisplayName

public ConnectorDescriptor removeAllDisplayName()

Removes the display-name element

Specified by:

removeAllDisplayName in interface ConnectorDescriptor

Returns:

the current instance of ConnectorDescriptor

getOrCreateIcon

public 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.

Specified by:

getOrCreateIcon in interface ConnectorDescriptor

Returns:

the instance defined for the element icon

createIcon

public IconType<ConnectorDescriptor> createIcon()

Creates a new icon element

Specified by:

createIcon in interface ConnectorDescriptor

Returns:

the new created instance of IconType

getAllIcon

public List<IconType<ConnectorDescriptor>> getAllIcon()

Returns all icon elements

Specified by:

getAllIcon in interface ConnectorDescriptor

Returns:

list of icon

removeAllIcon

public ConnectorDescriptor removeAllIcon()

Removes all icon elements

Specified by:

removeAllIcon in interface ConnectorDescriptor

Returns:

the current instance of IconType