Package org.eclipse.emf.cdo.common.model
Interface CDOPackageUnit
-
- All Superinterfaces:
CDOTimeProvider,java.lang.Comparable<CDOPackageUnit>
- All Known Subinterfaces:
InternalCDOPackageUnit
public interface CDOPackageUnit extends java.lang.Comparable<CDOPackageUnit>, CDOTimeProvider
Represents a tree structure of nestedpackagesthat are registered with apackage registryand that can only be serialized as a whole.A package unit is the granule of committing or lazy loading packages. It contains some overall information like
type,state,commit timeand nestedpackage infoobjects that describe all the nested packages.- Since:
- 2.0
- Author:
- Eike Stepper
- No Implement
- This interface is not intended to be implemented by clients.
- No Extend
- This interface is not intended to be extended by clients.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classCDOPackageUnit.StateDescribes the possible states apackage unitmay be in during its lifecycle.static classCDOPackageUnit.Type
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description org.eclipse.emf.ecore.EPackage[]getEPackages(boolean loadOnDemand)Returns allpackagesof the nested package tree structure described by this package unit in depth-first traversal order.java.lang.StringgetID()Returns the ID of this package unit.CDOPackageUnit.TypegetOriginalType()Returns the type of this package unit as it was at the time it was originally committed by a client.CDOPackageInfogetPackageInfo(java.lang.String packageURI)Returns thepackage infoobject that describes thepackagewith the given namespace URI, ornullif this package unit does not contain a package with this URI.CDOPackageInfo[]getPackageInfos()Returns allpackage infoobjects of the nested package tree structure described by this package unit in depth-first traversal order.CDOPackageRegistrygetPackageRegistry()Returns the package registry this package unit is managed by.CDOPackageUnit.StategetState()Returns the current state of this package unit.longgetTimeStamp()Returns the time this package unit was originally committed.CDOPackageInfogetTopLevelPackageInfo()Returns thepackage infoobject that describes the top levelpackageof the nested package tree structure described by this package unit.CDOPackageUnit.TypegetType()Returns the current type of this package unit.booleanisResource()Returnstrueis this package unit describes the model Eresource ,falseotherwise.booleanisSystem()Returnstrueis this package unit describes one of the models Ecore, Eresource or Etypes,falseotherwise.
-
-
-
Method Detail
-
getPackageRegistry
CDOPackageRegistry getPackageRegistry()
Returns the package registry this package unit is managed by.
-
getID
java.lang.String getID()
Returns the ID of this package unit.Same as
getTopLevelPackageInfo().CDOPackageInfo.getPackageURI().
-
getState
CDOPackageUnit.State getState()
Returns the current state of this package unit.
-
getType
CDOPackageUnit.Type getType()
Returns the current type of this package unit.
-
getOriginalType
CDOPackageUnit.Type getOriginalType()
Returns the type of this package unit as it was at the time it was originally committed by a client.
-
getTimeStamp
long getTimeStamp()
Returns the time this package unit was originally committed.- Specified by:
getTimeStampin interfaceCDOTimeProvider
-
getTopLevelPackageInfo
CDOPackageInfo getTopLevelPackageInfo()
Returns thepackage infoobject that describes the top levelpackageof the nested package tree structure described by this package unit.
-
getPackageInfo
CDOPackageInfo getPackageInfo(java.lang.String packageURI)
Returns thepackage infoobject that describes thepackagewith the given namespace URI, ornullif this package unit does not contain a package with this URI.
-
getPackageInfos
CDOPackageInfo[] getPackageInfos()
Returns allpackage infoobjects of the nested package tree structure described by this package unit in depth-first traversal order.
-
getEPackages
org.eclipse.emf.ecore.EPackage[] getEPackages(boolean loadOnDemand)
Returns allpackagesof the nested package tree structure described by this package unit in depth-first traversal order.
-
isSystem
boolean isSystem()
Returnstrueis this package unit describes one of the models Ecore, Eresource or Etypes,falseotherwise.Note that the models Ecore, Eresource and Etypes are expected to be present as generated
NATIVEmodels in all deployments.
-
isResource
boolean isResource()
Returnstrueis this package unit describes the model Eresource ,falseotherwise.Note that the model Eresource is expected to bepresent as generated
NATIVEmodels in all deployments.- Since:
- 4.0
-
-