org.objectweb.speedo.metadata
Class SpeedoPackage

java.lang.Object
  |
  +--org.objectweb.speedo.metadata.SpeedoElement
        |
        +--org.objectweb.speedo.metadata.SpeedoPackage

public class SpeedoPackage
extends SpeedoElement

Describes a package which contains persistence capable classes.

Author:
Y. Devaux

Field Summary
 java.util.Map jdoClass
          Persistence capable classes descriptors of the package.
 SpeedoXMLDescriptor jdoXMLDescriptor
          Descriptor to which this package is associated.
 java.lang.String name
          Package name.
 
Fields inherited from class org.objectweb.speedo.metadata.SpeedoElement
jdoExtension
 
Constructor Summary
SpeedoPackage()
           
 
Method Summary
 void add(java.lang.Object classe, boolean failsOnError, org.objectweb.util.monolog.api.Logger logger)
          Adds a class descriptor to the package descriptor.
 java.lang.String toString()
          Transforms a SpeedoPackage into a String.
 
Methods inherited from class org.objectweb.speedo.metadata.SpeedoElement
addExtension, getExtension, getExtensionByKey
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

name

public java.lang.String name
Package name.

jdoClass

public java.util.Map jdoClass
Persistence capable classes descriptors of the package. The HashMap key is the class name.

jdoXMLDescriptor

public SpeedoXMLDescriptor jdoXMLDescriptor
Descriptor to which this package is associated.
Constructor Detail

SpeedoPackage

public SpeedoPackage()
Method Detail

toString

public java.lang.String toString()
Transforms a SpeedoPackage into a String.
Overrides:
toString in class java.lang.Object
Returns:
the corresponding String.

add

public void add(java.lang.Object classe,
                boolean failsOnError,
                org.objectweb.util.monolog.api.Logger logger)
         throws SpeedoException
Adds a class descriptor to the package descriptor.
Parameters:
classe - class to add.
failsOnError - if an error provoques an exception or a warning message.
logger - logger where to put warning message.
Throws:
SpeedoException - If a field of the class descriptor is already defined into the package descriptor.