vdoclet.ejb
Class EjbBundle

java.lang.Object
  |
  +--vdoclet.ejb.EjbBundle

public class EjbBundle
extends Object

Represents a collection of EJBs


Field Summary
static String EJB_PROP_FILE
           
static String EJB_VERSION_PROP
           
protected static EjbBundle NULL_BUNDLE
           
static String SECURITY_ROLES_PROP
           
 
Constructor Summary
EjbBundle(DocInfo docInfo)
          Construct an EjbBundle from the specified javadoc info.
 
Method Summary
 Collection getAbstractEjbs()
          Return all the abstract Enterprise Beans
 DocInfo getDocInfo()
           
 EjbInfo getEjb(String name)
          Return a named EJB
 Collection getEjbs()
          Return all the Enterprise Beans
 float getEjbVersion()
          Determine which version of the EJB spec we're targeting
 Properties getPropertiesStartingWith(String prefix)
          Get all properties starting with the given prefix.
 String getProperty(String name)
          Fetch a bundle property
 String getProperty(String name, String defaultValue)
          Fetch a bundle property
 Collection getRelations()
          Return all EjbRelations
 Set getSecurityRoles()
          Get the security-roles defined for this bundle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EJB_PROP_FILE

public static final String EJB_PROP_FILE
See Also:
Constant Field Values

SECURITY_ROLES_PROP

public static final String SECURITY_ROLES_PROP
See Also:
Constant Field Values

EJB_VERSION_PROP

public static final String EJB_VERSION_PROP
See Also:
Constant Field Values

NULL_BUNDLE

protected static final EjbBundle NULL_BUNDLE
Constructor Detail

EjbBundle

public EjbBundle(DocInfo docInfo)
Construct an EjbBundle from the specified javadoc info.

Method Detail

getProperty

public String getProperty(String name)
Fetch a bundle property

Parameters:
name - property name
Returns:
the property value, or null if undefined

getProperty

public String getProperty(String name,
                          String defaultValue)
Fetch a bundle property

Parameters:
name - property name
defaultValue - a default value
Returns:
the property value, or defaultValue if undefined

getPropertiesStartingWith

public Properties getPropertiesStartingWith(String prefix)
Get all properties starting with the given prefix.

Returns:
the matching properties, with the prefix removed from the key.

getEjbVersion

public float getEjbVersion()
Determine which version of the EJB spec we're targeting


getSecurityRoles

public Set getSecurityRoles()
Get the security-roles defined for this bundle

Returns:
Set(String) of security-role names

getDocInfo

public DocInfo getDocInfo()

getEjbs

public Collection getEjbs()
Return all the Enterprise Beans

Returns:
Collection(EjbInfo)

getAbstractEjbs

public Collection getAbstractEjbs()
Return all the abstract Enterprise Beans

Returns:
Collection(EjbInfo)

getEjb

public EjbInfo getEjb(String name)
Return a named EJB

Parameters:
name - the name of the srcClass

getRelations

public Collection getRelations()
Return all EjbRelations