org.eclipse.jst.j2ee.common
Interface EnvEntry

All Superinterfaces:
org.eclipse.emf.ecore.EObject, J2EEEObject, org.eclipse.emf.common.notify.Notifier

public interface EnvEntry
extends J2EEEObject

The env-entry element contains the declaration of an application client's environment entries. The declaration consists of an optional description, the name of the environment entry, and an optional value.

Since:
1.0

Method Summary
 java.lang.String getDescription()
           
 org.eclipse.emf.common.util.EList getDescriptions()
          Returns the value of the 'Descriptions' containment reference list.
 java.lang.String getName()
           
 EnvEntryType getType()
           
 java.lang.String getValue()
           
 boolean isSetType()
          Returns whether the value of the 'Type' attribute is set
 void setDescription(java.lang.String value)
           
 void setName(java.lang.String value)
           
 void setType(EnvEntryType value)
          Sets the value of the 'Type' attribute
 void setValue(java.lang.String value)
           
 void unsetType()
          Unsets the value of the 'Type' attribute
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getDescription

java.lang.String getDescription()
Returns:
The value of the Description attribute The description element is used by the ejb-jar file producer to provide text describing the parent element. The description element should include any information that the ejb-jar file producer wants to provide to the consumer of the ejb-jar file (i.e. to the Deployer). Typically, the tools used by the ejb-jar file consumer will display the description when processing the parent element.

setDescription

void setDescription(java.lang.String value)
Parameters:
value - The new value of the Description attribute

getName

java.lang.String getName()
Returns:
The value of the Name attribute The env-entry-name element contains the name of an application client's environment entry.

setName

void setName(java.lang.String value)
Parameters:
value - The new value of the Name attribute

getValue

java.lang.String getValue()
Returns:
The value of the Value attribute The env-entry-value element contains the value of an application client's environment entry. The value must be a String that is valid for the constructor of the specified type that takes a single String parameter. Used in: env-entry Example: //datasources//MyDatabase

setValue

void setValue(java.lang.String value)
Parameters:
value - The new value of the Value attribute

getType

EnvEntryType getType()
Returns:
The value of the Type attribute The env-entry-type element contains the fully-qualified Java type of the environment entry value that is expected by the application client's code. The following are the legal values of env-entry-type: java.lang.Bool-ean, java.lang.String, java.lang.Integer, java.lang.Double, java.lang.Byte, java.lang.Short, java.lang.Long, and java.lang.Float. Example: java.lang.Boolean

setType

void setType(EnvEntryType value)
Sets the value of the 'Type' attribute.

Parameters:
value - the new value of the 'Type' attribute.
See Also:
EnvEntryType, isSetType(), unsetType(), getType()

unsetType

void unsetType()
Unsets the value of the 'Type' attribute.

See Also:
isSetType(), getType(), setType(EnvEntryType)

isSetType

boolean isSetType()
Returns whether the value of the 'Type' attribute is set.

Returns:
whether the value of the 'Type' attribute is set.
See Also:
unsetType(), getType(), setType(EnvEntryType)

getDescriptions

org.eclipse.emf.common.util.EList getDescriptions()
Returns the value of the 'Descriptions' containment reference list. The list contents are of type Description.

If the meaning of the 'Descriptions' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Descriptions' containment reference list.
See Also:
CommonPackage.getEnvEntry_Descriptions()