Interface ConnectorDescriptor
-
- All Superinterfaces:
org.jboss.shrinkwrap.descriptor.api.Descriptor,org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace<ConnectorDescriptor>
- All Known Implementing Classes:
ConnectorDescriptorImpl
public interface ConnectorDescriptor extends org.jboss.shrinkwrap.descriptor.api.Descriptor, org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace<ConnectorDescriptor>
This deployment descriptor provides the functionalities as described in the specification
Example:
ConnectorDescriptor descriptor = Descriptors.create(ConnectorDescriptor.class);
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IconType<ConnectorDescriptor>createIcon()Creates a newiconelementConnectorDescriptordescription(String... values)Creates for all String objects representingdescriptionelements, a newdescriptionelementConnectorDescriptordisplayName(String... values)Creates for all String objects representingdisplay-nameelements, a newdisplay-nameelementConnectorDescriptoreisType(String eisType)Sets theeis-typeelementList<String>getAllDescription()Returns alldescriptionelementsList<String>getAllDisplayName()Returns alldisplay-nameelementsList<IconType<ConnectorDescriptor>>getAllIcon()Returns alliconelementsStringgetEisType()Returns theeis-typeelementStringgetId()Returns theidattributeIconType<ConnectorDescriptor>getOrCreateIcon()If not already created, a newiconelement will be created and returned.LicenseType<ConnectorDescriptor>getOrCreateLicense()If not already created, a newlicenseelement with the given value will be created.ResourceadapterType<ConnectorDescriptor>getOrCreateResourceadapter()If not already created, a newresourceadapterelement with the given value will be created.StringgetResourceadapterVersion()Returns theresourceadapter-versionelementStringgetVendorName()Returns thevendor-nameelementStringgetVersion()Returns theversionattributeConnectorDescriptorid(String id)Sets theidattributeConnectorDescriptorremoveAllDescription()Removes thedescriptionelementConnectorDescriptorremoveAllDisplayName()Removes thedisplay-nameelementConnectorDescriptorremoveAllIcon()Removes alliconelementsConnectorDescriptorremoveEisType()Removes theeis-typeelementConnectorDescriptorremoveId()Removes theidattributeConnectorDescriptorremoveLicense()Removes thelicenseelementConnectorDescriptorremoveResourceadapter()Removes theresourceadapterelementConnectorDescriptorremoveResourceadapterVersion()Removes theresourceadapter-versionelementConnectorDescriptorremoveVendorName()Removes thevendor-nameelementConnectorDescriptorremoveVersion()Removes theversionattributeConnectorDescriptorresourceadapterVersion(String resourceadapterVersion)Sets theresourceadapter-versionelementConnectorDescriptorvendorName(String vendorName)Sets thevendor-nameelementConnectorDescriptorversion(String version)Sets theversionattribute
-
-
-
Field Detail
-
VERSION
static final String VERSION
- See Also:
- Constant Field Values
-
-
Method Detail
-
description
ConnectorDescriptor description(String... values)
Creates for all String objects representingdescriptionelements, a newdescriptionelement- Parameters:
values- list ofdescriptionobjects- Returns:
- the current instance of
ConnectorDescriptor
-
getAllDescription
List<String> getAllDescription()
Returns alldescriptionelements- Returns:
- list of
description
-
removeAllDescription
ConnectorDescriptor removeAllDescription()
Removes thedescriptionelement- Returns:
- the current instance of
ConnectorDescriptor
-
displayName
ConnectorDescriptor displayName(String... values)
Creates for all String objects representingdisplay-nameelements, a newdisplay-nameelement- Parameters:
values- list ofdisplay-nameobjects- Returns:
- the current instance of
ConnectorDescriptor
-
getAllDisplayName
List<String> getAllDisplayName()
Returns alldisplay-nameelements- Returns:
- list of
display-name
-
removeAllDisplayName
ConnectorDescriptor removeAllDisplayName()
Removes thedisplay-nameelement- Returns:
- the current instance of
ConnectorDescriptor
-
getOrCreateIcon
IconType<ConnectorDescriptor> getOrCreateIcon()
If not already created, a newiconelement will be created and returned. Otherwise, the first existingiconelement will be returned.- Returns:
- the instance defined for the element
icon
-
createIcon
IconType<ConnectorDescriptor> createIcon()
Creates a newiconelement- Returns:
- the new created instance of
IconType
-
getAllIcon
List<IconType<ConnectorDescriptor>> getAllIcon()
Returns alliconelements- Returns:
- list of
icon
-
removeAllIcon
ConnectorDescriptor removeAllIcon()
Removes alliconelements- Returns:
- the current instance of
IconType
-
vendorName
ConnectorDescriptor vendorName(String vendorName)
Sets thevendor-nameelement- Parameters:
vendorName- the value for the elementvendor-name- Returns:
- the current instance of
ConnectorDescriptor
-
getVendorName
String getVendorName()
Returns thevendor-nameelement- Returns:
- the node defined for the element
vendor-name
-
removeVendorName
ConnectorDescriptor removeVendorName()
Removes thevendor-nameelement- Returns:
- the current instance of
ConnectorDescriptor
-
eisType
ConnectorDescriptor eisType(String eisType)
Sets theeis-typeelement- Parameters:
eisType- the value for the elementeis-type- Returns:
- the current instance of
ConnectorDescriptor
-
getEisType
String getEisType()
Returns theeis-typeelement- Returns:
- the node defined for the element
eis-type
-
removeEisType
ConnectorDescriptor removeEisType()
Removes theeis-typeelement- Returns:
- the current instance of
ConnectorDescriptor
-
resourceadapterVersion
ConnectorDescriptor resourceadapterVersion(String resourceadapterVersion)
Sets theresourceadapter-versionelement- Parameters:
resourceadapterVersion- the value for the elementresourceadapter-version- Returns:
- the current instance of
ConnectorDescriptor
-
getResourceadapterVersion
String getResourceadapterVersion()
Returns theresourceadapter-versionelement- Returns:
- the node defined for the element
resourceadapter-version
-
removeResourceadapterVersion
ConnectorDescriptor removeResourceadapterVersion()
Removes theresourceadapter-versionelement- Returns:
- the current instance of
ConnectorDescriptor
-
getOrCreateLicense
LicenseType<ConnectorDescriptor> getOrCreateLicense()
If not already created, a newlicenseelement with the given value will be created. Otherwise, the existinglicenseelement will be returned.- Returns:
- a new or existing instance of
LicenseType
-
removeLicense
ConnectorDescriptor removeLicense()
Removes thelicenseelement- Returns:
- the current instance of
ConnectorDescriptor
-
getOrCreateResourceadapter
ResourceadapterType<ConnectorDescriptor> getOrCreateResourceadapter()
If not already created, a newresourceadapterelement with the given value will be created. Otherwise, the existingresourceadapterelement will be returned.- Returns:
- a new or existing instance of
ResourceadapterType
-
removeResourceadapter
ConnectorDescriptor removeResourceadapter()
Removes theresourceadapterelement- Returns:
- the current instance of
ConnectorDescriptor
-
version
ConnectorDescriptor version(String version)
Sets theversionattribute- Parameters:
version- the value for the attributeversion- Returns:
- the current instance of
ConnectorDescriptor
-
getVersion
String getVersion()
Returns theversionattribute- Returns:
- the value defined for the attribute
version
-
removeVersion
ConnectorDescriptor removeVersion()
Removes theversionattribute- Returns:
- the current instance of
ConnectorDescriptor
-
id
ConnectorDescriptor id(String id)
Sets theidattribute- Parameters:
id- the value for the attributeid- Returns:
- the current instance of
ConnectorDescriptor
-
getId
String getId()
Returns theidattribute- Returns:
- the value defined for the attribute
id
-
removeId
ConnectorDescriptor removeId()
Removes theidattribute- Returns:
- the current instance of
ConnectorDescriptor
-
-