Package org.jboss.shrinkwrap.descriptor.impl.connector10

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.connector10.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);

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ConnectorDescriptor	addDefaultNamespaces()	Adds the default namespaces as defined in the specification
ConnectorDescriptor	addNamespace(String name, String value)	Adds a new namespace
ConnectorDescriptor	description(String description)	Sets the description element
ConnectorDescriptor	displayName(String displayName)	Sets the display-name element
ConnectorDescriptor	eisType(String eisType)	Sets the eis-type element
String	getDescription()	Returns the description element
String	getDisplayName()	Returns the display-name element
String	getEisType()	Returns the eis-type element
List<String>	getNamespaces()	Returns all defined namespaces.
Icon<ConnectorDescriptor>	getOrCreateIcon()	If not already created, a new icon element with the given value will be created.
License<ConnectorDescriptor>	getOrCreateLicense()	If not already created, a new license element with the given value will be created.
Resourceadapter<ConnectorDescriptor>	getOrCreateResourceadapter()	If not already created, a new resourceadapter element with the given value will be created.
org.jboss.shrinkwrap.descriptor.spi.node.Node	getRootNode()
String	getSpecVersion()	Returns the spec-version element
String	getVendorName()	Returns the vendor-name element
String	getVersion()	Returns the version element
ConnectorDescriptor	removeAllNamespaces()	Removes all existing namespaces.
ConnectorDescriptor	removeDescription()	Removes the description element
ConnectorDescriptor	removeDisplayName()	Removes the display-name element
ConnectorDescriptor	removeEisType()	Removes the eis-type element
ConnectorDescriptor	removeIcon()	Removes the icon element
ConnectorDescriptor	removeLicense()	Removes the license element
ConnectorDescriptor	removeResourceadapter()	Removes the resourceadapter element
ConnectorDescriptor	removeSpecVersion()	Removes the spec-version element
ConnectorDescriptor	removeVendorName()	Removes the vendor-name element
ConnectorDescriptor	removeVersion()	Removes the version element
ConnectorDescriptor	specVersion(String specVersion)	Sets the spec-version element
ConnectorDescriptor	vendorName(String vendorName)	Sets the vendor-name element
ConnectorDescriptor	version(String version)	Sets the version element

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

specVersion

public ConnectorDescriptor specVersion(String specVersion)

Sets the spec-version element

Specified by:

specVersion in interface ConnectorDescriptor

Parameters:

specVersion - the value for the element spec-version

Returns:

the current instance of ConnectorDescriptor

getSpecVersion

public String getSpecVersion()

Returns the spec-version element

Specified by:

getSpecVersion in interface ConnectorDescriptor

Returns:

the node defined for the element spec-version

removeSpecVersion

public ConnectorDescriptor removeSpecVersion()

Removes the spec-version element

Specified by:

removeSpecVersion in interface ConnectorDescriptor

Returns:

the current instance of ConnectorDescriptor

getOrCreateLicense

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

removeLicense

public ConnectorDescriptor removeLicense()

Removes the license element

Specified by:

removeLicense in interface ConnectorDescriptor

Returns:

the current instance of ConnectorDescriptor

displayName

public ConnectorDescriptor displayName(String displayName)

Sets the display-name element

Specified by:

displayName in interface ConnectorDescriptor

Parameters:

displayName - the value for the element display-name

Returns:

the current instance of ConnectorDescriptor

getDisplayName

public String getDisplayName()

Returns the display-name element

Specified by:

getDisplayName in interface ConnectorDescriptor

Returns:

the node defined for the element display-name

removeDisplayName

public ConnectorDescriptor removeDisplayName()

Removes the display-name element

Specified by:

removeDisplayName in interface ConnectorDescriptor

Returns:

the current instance of ConnectorDescriptor

getOrCreateIcon

public Icon<ConnectorDescriptor> getOrCreateIcon()

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

Specified by:

getOrCreateIcon in interface ConnectorDescriptor

Returns:

a new or existing instance of Icon

removeIcon

public ConnectorDescriptor removeIcon()

Removes the icon element

Specified by:

removeIcon in interface ConnectorDescriptor

Returns:

the current instance of ConnectorDescriptor

description

public ConnectorDescriptor description(String description)

Sets the description element

Specified by:

description in interface ConnectorDescriptor

Parameters:

description - the value for the element description

Returns:

the current instance of ConnectorDescriptor

getDescription

public String getDescription()

Returns the description element

Specified by:

getDescription in interface ConnectorDescriptor

Returns:

the node defined for the element description

removeDescription

public ConnectorDescriptor removeDescription()

Removes the description element

Specified by:

removeDescription 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

version

public ConnectorDescriptor version(String version)

Sets the version element

Specified by:

version in interface ConnectorDescriptor

Parameters:

version - the value for the element version

Returns:

the current instance of ConnectorDescriptor

getVersion

public String getVersion()

Returns the version element

Specified by:

getVersion in interface ConnectorDescriptor

Returns:

the node defined for the element version

removeVersion

public ConnectorDescriptor removeVersion()

Removes the version element

Specified by:

removeVersion in interface ConnectorDescriptor

Returns:

the current instance of ConnectorDescriptor

getOrCreateResourceadapter

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

removeResourceadapter

public ConnectorDescriptor removeResourceadapter()

Removes the resourceadapter element

Specified by:

removeResourceadapter in interface ConnectorDescriptor

Returns:

the current instance of ConnectorDescriptor