org.apache.openejb.jee
Class EnvEntry

java.lang.Object
  extended by org.apache.openejb.jee.EnvEntry
All Implemented Interfaces:
Injectable, JndiReference, Keyable<java.lang.String>

public class EnvEntry
extends java.lang.Object
implements JndiReference

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.


Field Summary
protected  java.util.List<Text> description
           
protected  java.lang.String envEntryName
           
protected  java.lang.String envEntryType
           
protected  java.lang.String envEntryValue
           
protected  java.lang.String id
           
protected  java.util.List<InjectionTarget> injectionTarget
           
protected  java.lang.String mappedName
           
 
Constructor Summary
EnvEntry()
           
EnvEntry(java.lang.String envEntryName, java.lang.Class<?> envEntryType, java.lang.String envEntryValue)
           
EnvEntry(java.lang.String envEntryName, java.lang.String envEntryType, java.lang.String envEntryValue)
           
 
Method Summary
 java.util.List<Text> getDescription()
           
 java.lang.String getEnvEntryName()
           
 java.lang.String getEnvEntryType()
          Gets the value of the envEntryType property.
 java.lang.String getEnvEntryValue()
           
 java.lang.String getId()
           
 java.util.List<InjectionTarget> getInjectionTarget()
           
 java.lang.String getKey()
          Gets the immutable key for this object.
 java.lang.String getMappedName()
           
 java.lang.String getName()
           
 java.lang.String getType()
           
 void setEnvEntryName(java.lang.String value)
           
 void setEnvEntryType(java.lang.String value)
           
 void setEnvEntryValue(java.lang.String value)
           
 void setId(java.lang.String value)
           
 void setMappedName(java.lang.String value)
           
 void setName(java.lang.String name)
           
 void setType(java.lang.String type)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

description

protected java.util.List<Text> description

envEntryName

protected java.lang.String envEntryName

envEntryType

protected java.lang.String envEntryType

envEntryValue

protected java.lang.String envEntryValue

mappedName

protected java.lang.String mappedName

injectionTarget

protected java.util.List<InjectionTarget> injectionTarget

id

protected java.lang.String id
Constructor Detail

EnvEntry

public EnvEntry()

EnvEntry

public EnvEntry(java.lang.String envEntryName,
                java.lang.String envEntryType,
                java.lang.String envEntryValue)

EnvEntry

public EnvEntry(java.lang.String envEntryName,
                java.lang.Class<?> envEntryType,
                java.lang.String envEntryValue)
Method Detail

getName

public java.lang.String getName()
Specified by:
getName in interface JndiReference

getType

public java.lang.String getType()
Specified by:
getType in interface JndiReference

setName

public void setName(java.lang.String name)
Specified by:
setName in interface JndiReference

getKey

public java.lang.String getKey()
Description copied from interface: Keyable
Gets the immutable key for this object.

Specified by:
getKey in interface Keyable<java.lang.String>
Returns:
gets the immutable key for this object

setType

public void setType(java.lang.String type)
Specified by:
setType in interface JndiReference

getDescription

public java.util.List<Text> getDescription()

getEnvEntryName

public java.lang.String getEnvEntryName()

setEnvEntryName

public void setEnvEntryName(java.lang.String value)

getEnvEntryType

public java.lang.String getEnvEntryType()
Gets the value of the envEntryType property.


setEnvEntryType

public void setEnvEntryType(java.lang.String value)

getEnvEntryValue

public java.lang.String getEnvEntryValue()

setEnvEntryValue

public void setEnvEntryValue(java.lang.String value)

getMappedName

public java.lang.String getMappedName()
Specified by:
getMappedName in interface JndiReference

setMappedName

public void setMappedName(java.lang.String value)
Specified by:
setMappedName in interface JndiReference

getInjectionTarget

public java.util.List<InjectionTarget> getInjectionTarget()
Specified by:
getInjectionTarget in interface Injectable

getId

public java.lang.String getId()

setId

public void setId(java.lang.String value)


Copyright © 1999-2011 The Apache OpenEJB development community. All Rights Reserved.