org.jboss.shrinkwrap.descriptor.api.jboss51
Interface JndiRefType<T>

All Superinterfaces:
org.jboss.shrinkwrap.descriptor.api.Child<T>
All Known Implementing Classes:
JndiRefTypeImpl

public interface JndiRefType<T>
extends org.jboss.shrinkwrap.descriptor.api.Child<T>

This interface defines the contract for the jndi-refType xsd type

Original Documentation:



Used to inject generic types based on JNDI name


Since:
Generation date :2011-07-19T22:54:35.59+02:00
Author:
Ralf Battenfeld

Method Summary
 java.util.List<java.lang.String> getDescriptionList()
          Returns all description elements
 java.util.List<InjectionTargetType<JndiRefType<T>>> getInjectionTargetList()
          Returns all injection-target elements
 java.lang.String getJndiName()
          Returns the jndi-name element
 java.lang.String getJndiRefName()
          Returns the jndi-ref-name element
 java.lang.String getMappedName()
          Returns the mapped-name element
 JndiRefType<T> ignoreDependency()
           
 InjectionTargetType<JndiRefType<T>> injectionTarget()
          Returns the injection-target element
 java.lang.Boolean isIgnoreDependency()
           
 JndiRefType<T> removeAllDescription()
          Removes the description element
 JndiRefType<T> removeAllInjectionTarget()
          Removes all injection-target elements
 JndiRefType<T> removeJndiName()
          Removes the jndi-name element
 JndiRefType<T> removeJndiRefName()
          Removes the jndi-ref-name element
 JndiRefType<T> removeMappedName()
          Removes the mapped-name element
 JndiRefType<T> setDescription(java.lang.String description)
          Creates a new description element
 JndiRefType<T> setDescriptionList(java.lang.String... values)
          Creates for all String objects representing description elements, a new description element
 JndiRefType<T> setJndiName(java.lang.String jndiName)
          If not already created, a new jndi-name element with the given value will be created.
 JndiRefType<T> setJndiRefName(java.lang.String jndiRefName)
          If not already created, a new jndi-ref-name element with the given value will be created.
 JndiRefType<T> setMappedName(java.lang.String mappedName)
          If not already created, a new mapped-name element with the given value will be created.
 
Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child
up
 

Method Detail

setJndiName

JndiRefType<T> setJndiName(java.lang.String jndiName)
If not already created, a new jndi-name element with the given value will be created. Otherwise, the existing jndi-name element will be updated with the given value.

Returns:
the current instance of JndiRefType

removeJndiName

JndiRefType<T> removeJndiName()
Removes the jndi-name element

Returns:
the current instance of JndiRefType

getJndiName

java.lang.String getJndiName()
Returns the jndi-name element

Returns:
the node defined for the element jndi-name

setMappedName

JndiRefType<T> setMappedName(java.lang.String mappedName)
If not already created, a new mapped-name element with the given value will be created. Otherwise, the existing mapped-name element will be updated with the given value.

Returns:
the current instance of JndiRefType

removeMappedName

JndiRefType<T> removeMappedName()
Removes the mapped-name element

Returns:
the current instance of JndiRefType

getMappedName

java.lang.String getMappedName()
Returns the mapped-name element

Returns:
the node defined for the element mapped-name

removeAllInjectionTarget

JndiRefType<T> removeAllInjectionTarget()
Removes all injection-target elements

Returns:
the current instance of JndiRefType

injectionTarget

InjectionTargetType<JndiRefType<T>> injectionTarget()
Returns the injection-target element

Returns:
the node defined for the element injection-target

getInjectionTargetList

java.util.List<InjectionTargetType<JndiRefType<T>>> getInjectionTargetList()
Returns all injection-target elements

Returns:
list of injection-target

ignoreDependency

JndiRefType<T> ignoreDependency()

isIgnoreDependency

java.lang.Boolean isIgnoreDependency()

setDescription

JndiRefType<T> setDescription(java.lang.String description)
Creates a new description element

Returns:
the current instance of JndiRefType

setDescriptionList

JndiRefType<T> setDescriptionList(java.lang.String... values)
Creates for all String objects representing description elements, a new description element

Parameters:
list - of description objects
Returns:
the current instance of JndiRefType

removeAllDescription

JndiRefType<T> removeAllDescription()
Removes the description element

Returns:
the current instance of JndiRefType

getDescriptionList

java.util.List<java.lang.String> getDescriptionList()
Returns all description elements

Returns:
list of description

setJndiRefName

JndiRefType<T> setJndiRefName(java.lang.String jndiRefName)
If not already created, a new jndi-ref-name element with the given value will be created. Otherwise, the existing jndi-ref-name element will be updated with the given value.

Returns:
the current instance of JndiRefType

removeJndiRefName

JndiRefType<T> removeJndiRefName()
Removes the jndi-ref-name element

Returns:
the current instance of JndiRefType

getJndiRefName

java.lang.String getJndiRefName()
Returns the jndi-ref-name element

Returns:
the node defined for the element jndi-ref-name