|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EnvEntryType<T>
This interface defines the contract for the env-entryType
xsd type
Original Documentation:
The env-entryType is used to declare an application's
environment entry. The declaration consists of an optional
description, the name of the environment entry, a type
(optional if the value is injected, otherwise required), and
an optional value.
It also includes optional elements to define injection of
the named resource into fields or JavaBeans properties.
If a value is not specified and injection is requested,
no injection will occur and no entry of the specified name
will be created. This allows an initial value to be
specified in the source code without being incorrectly
changed when no override has been specified.
If a value is not specified and no injection is requested,
a value must be supplied during deployment.
This type is used by env-entry elements.
Method Summary | |
---|---|
java.util.List<java.lang.String> |
getDescriptionList()
Returns all description elements |
java.lang.String |
getEnvEntryName()
Returns the env-entry-name element |
java.lang.String |
getEnvEntryType()
Returns the env-entry-type element |
java.lang.String |
getEnvEntryValue()
Returns the env-entry-value element |
java.util.List<InjectionTargetType<EnvEntryType<T>>> |
getInjectionTargetList()
Returns all injection-target elements |
java.lang.String |
getLookupName()
Returns the lookup-name element |
java.lang.String |
getMappedName()
Returns the mapped-name element |
InjectionTargetType<EnvEntryType<T>> |
injectionTarget()
Returns the injection-target element |
EnvEntryType<T> |
removeAllDescription()
Removes the description element |
EnvEntryType<T> |
removeAllInjectionTarget()
Removes all injection-target elements |
EnvEntryType<T> |
removeEnvEntryName()
Removes the env-entry-name element |
EnvEntryType<T> |
removeEnvEntryType()
Removes the env-entry-type element |
EnvEntryType<T> |
removeEnvEntryValue()
Removes the env-entry-value element |
EnvEntryType<T> |
removeLookupName()
Removes the lookup-name element |
EnvEntryType<T> |
removeMappedName()
Removes the mapped-name element |
EnvEntryType<T> |
setDescription(java.lang.String description)
Creates a new description element |
EnvEntryType<T> |
setDescriptionList(java.lang.String... values)
Creates for all String objects representing description elements,
a new description element |
EnvEntryType<T> |
setEnvEntryName(java.lang.String envEntryName)
If not already created, a new env-entry-name element with the given value will be created. |
EnvEntryType<T> |
setEnvEntryType(java.lang.String envEntryType)
If not already created, a new env-entry-type element with the given value will be created. |
EnvEntryType<T> |
setEnvEntryValue(java.lang.String envEntryValue)
If not already created, a new env-entry-value element with the given value will be created. |
EnvEntryType<T> |
setLookupName(java.lang.String lookupName)
If not already created, a new lookup-name element with the given value will be created. |
EnvEntryType<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 |
---|
EnvEntryType<T> setLookupName(java.lang.String lookupName)
lookup-name
element with the given value will be created.
Otherwise, the existing lookup-name
element will be updated with the given value.
EnvEntryType
EnvEntryType<T> removeLookupName()
lookup-name
element
EnvEntryType
java.lang.String getLookupName()
lookup-name
element
lookup-name
EnvEntryType<T> setMappedName(java.lang.String mappedName)
mapped-name
element with the given value will be created.
Otherwise, the existing mapped-name
element will be updated with the given value.
EnvEntryType
EnvEntryType<T> removeMappedName()
mapped-name
element
EnvEntryType
java.lang.String getMappedName()
mapped-name
element
mapped-name
EnvEntryType<T> removeAllInjectionTarget()
injection-target
elements
EnvEntryType
InjectionTargetType<EnvEntryType<T>> injectionTarget()
injection-target
element
injection-target
java.util.List<InjectionTargetType<EnvEntryType<T>>> getInjectionTargetList()
injection-target
elements
injection-target
EnvEntryType<T> setDescription(java.lang.String description)
description
element
EnvEntryType
EnvEntryType<T> setDescriptionList(java.lang.String... values)
description
elements,
a new description
element
list
- of description
objects
EnvEntryType
EnvEntryType<T> removeAllDescription()
description
element
EnvEntryType
java.util.List<java.lang.String> getDescriptionList()
description
elements
description
EnvEntryType<T> setEnvEntryName(java.lang.String envEntryName)
env-entry-name
element with the given value will be created.
Otherwise, the existing env-entry-name
element will be updated with the given value.
EnvEntryType
EnvEntryType<T> removeEnvEntryName()
env-entry-name
element
EnvEntryType
java.lang.String getEnvEntryName()
env-entry-name
element
env-entry-name
EnvEntryType<T> setEnvEntryType(java.lang.String envEntryType)
env-entry-type
element with the given value will be created.
Otherwise, the existing env-entry-type
element will be updated with the given value.
EnvEntryType
EnvEntryType<T> removeEnvEntryType()
env-entry-type
element
EnvEntryType
java.lang.String getEnvEntryType()
env-entry-type
element
env-entry-type
EnvEntryType<T> setEnvEntryValue(java.lang.String envEntryValue)
env-entry-value
element with the given value will be created.
Otherwise, the existing env-entry-value
element will be updated with the given value.
EnvEntryType
EnvEntryType<T> removeEnvEntryValue()
env-entry-value
element
EnvEntryType
java.lang.String getEnvEntryValue()
env-entry-value
element
env-entry-value
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |