|
||||||||||
PREV CLASS SOURCE NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.eclipse.emf.ecore.util.EcoreUtil
This class contains convenient static methods for working with EMF objects.
Inner Class Summary | |
---|---|
static class |
EcoreUtil.ContentTreeIterator
An iterator over the tree contents of a collection of EObjects, Resources, and ResourceSets; use getAllContents to create a new instance. |
static class |
EcoreUtil.Copier
A mapping building traverser of a collection of content trees ;
the map is from EObject to EObject , i.e., from original to copy;
use EcoreUtil.copy or EcoreUtil.copyAll to do routine copies. |
static class |
EcoreUtil.CrossReferencer
A mapping building traverser of a collection of content trees ;
the map is from target object to a collection of EStructuralFeature.Setting . |
static class |
EcoreUtil.ExternalCrossReferencer
A cross referencer that finds all references that are not contained within the content trees. |
static class |
EcoreUtil.ProxyCrossReferencer
A cross referencer that finds proxies; the cross referencer will not cause proxies to be resolved. |
static class |
EcoreUtil.UnresolvedProxyCrossReferencer
A cross referencer that finds proxies that cannot be resolved. |
static class |
EcoreUtil.UsageCrossReferencer
A cross referencer that finds each usage of an EObject or collection of EObjects. |
Constructor Summary | |
---|---|
EcoreUtil()
|
Method Summary | |
---|---|
static java.lang.String |
convertToString(EDataType eDataType,
java.lang.Object value)
Converts an instance of the datatype to a string literal representation. |
static EObject |
copy(EObject eObject)
Returns a self-contained copy of the eObject. |
static java.util.Collection |
copyAll(java.util.Collection eObjects)
Returns a collection of the self-contained copies of each EObject in eObjects. |
static EObject |
create(EClass eClass)
Creates an instance of the class. |
static java.lang.Object |
createFromString(EDataType eDataType,
java.lang.String literal)
Creates an instance of the datatype. |
static Adapter |
getAdapter(java.util.List adapters,
java.lang.Object type)
Returns the adapter of the specified type. |
static AdapterFactory |
getAdapterFactory(java.util.List adapterFactories,
java.lang.Object type)
Returns the adapter factory for the specified adapter type. |
static TreeIterator |
getAllContents(java.util.Collection emfObjects)
Returns a tree iterator over the content trees recursively defined by ResourceSet.getResources() ,
Resource.getContents() ,
and EObject.eContents() . |
static Adapter |
getExistingAdapter(Notifier notifier,
java.lang.Object type)
Returns the specified notifier's exisiting adapter of the specified type. |
static java.lang.String |
getID(EObject eObject)
Returns the value of the object's ID attribute as a String. |
static java.lang.String |
getIdentification(EObject eObject)
Returns a unique string identification of the eObject; it is structured as follows: |
static java.lang.Object |
getObjectByType(java.util.Collection objects,
EClassifier type)
Returns the first collection member that is an instance of the type. |
static java.util.Collection |
getObjectsByType(java.util.Collection objects,
EClassifier type)
Returns a collection containing each collection member that is an instance of the type. |
static Adapter |
getRegisteredAdapter(EObject eObject,
java.lang.Object type)
Returns the specified eObject's adapter of the specified type. |
static EObject |
getRootContainer(EObject eObject)
Returns the root container; it may be this object itself and it will have a null container . |
static URI |
getURI(EObject eObject)
Returns a URI for the eObject, i.e., either the eProxyURI, the URI of the eResource with the fragment produced by the eResource, or the URI consisting of just the fragment that would be produced by a default Resource with the eObject as its only contents. |
static boolean |
isAncestor(java.util.Collection ancestorEMFObjects,
EObject eObject)
Returns whether any EObject, Resource, or ResourceSet in the collection is an ancestor of the EObject. |
static boolean |
isAncestor(EObject ancestorEObject,
EObject eObject)
Returns whether the second object is directly or indirectly contained by the first object, i.e., whether the second object is in the content tree of the first. |
static boolean |
isAncestor(Resource ancestorResource,
EObject eObject)
Returns whether the given resource is that of the object, i.e., whether the object is in the content tree of the resource. |
static boolean |
isAncestor(ResourceSet ancestorResourceSet,
EObject eObject)
Returns whether the given resource set is that of the object, i.e., whether the object is in the content tree of the resource set. |
static void |
remove(EObject eObject)
Removes the object from its containing resource
or its containing object. |
static void |
remove(EObject eObject,
EStructuralFeature eStructuralFeature,
java.lang.Object value)
Removes the value from the feature of the object. |
static void |
remove(EStructuralFeature.Setting setting,
java.lang.Object value)
Removes the value from the setting. |
static void |
replace(EObject eObject,
EObject replacementEObject)
Replace the object in its containing resource
or its containing object,
with the replacement object. |
static void |
replace(EObject eObject,
EStructuralFeature eStructuralFeature,
java.lang.Object oldValue,
java.lang.Object newValue)
Replaces the old value in the object's feature with the new value. |
static void |
replace(EStructuralFeature.Setting setting,
java.lang.Object oldValue,
java.lang.Object newValue)
Replaces the old value in the setting with the new value. |
static EObject |
resolve(EObject proxy,
EObject objectContext)
Returns the resolved object represented by proxy. |
static EObject |
resolve(EObject proxy,
Resource resourceContext)
Returns the resolved object represented by proxy. |
static EObject |
resolve(EObject proxy,
ResourceSet resourceSet)
Returns the resolved object represented by proxy. |
static void |
setEList(EList eList,
java.util.Collection prototypeList)
Sets the eList 's contents and order to be exactly that of the prototype collection. |
static void |
setID(EObject eObject,
java.lang.String id)
Sets the value of the object's ID attribute according to the value represented by the String. |
static java.lang.Class |
wrapperClassFor(java.lang.Class javaClass)
Returns the wrapper class for the primitive class, or the original class, if it's not a primitive class. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public EcoreUtil()
Method Detail |
public static Adapter getExistingAdapter(Notifier notifier, java.lang.Object type)
notifier
- the adapted object.type
- the type of adapter.public static Adapter getRegisteredAdapter(EObject eObject, java.lang.Object type)
eObject
- the adapted object.type
- the type of adapter.public static Adapter getAdapter(java.util.List adapters, java.lang.Object type)
adapters
- list of adapters to search.type
- the type of adapter.public static AdapterFactory getAdapterFactory(java.util.List adapterFactories, java.lang.Object type)
adapters
- list of adapter factories to search.type
- the type of adapter.public static EObject resolve(EObject proxy, ResourceSet resourceSet)
proxy
- the proxy to be resolved.resourceSet
- the resource set in which to resolve.public static EObject resolve(EObject proxy, Resource resourceContext)
proxy
- the proxy to be resolved.resourceContext
- a context resource whose resource set is used for the resolve.public static EObject resolve(EObject proxy, EObject objectContext)
proxy
- the proxy to be resolved.objectContext
- a context object whose resource set is used for the resolve.public static java.lang.Object getObjectByType(java.util.Collection objects, EClassifier type)
is an instance
of the type.objects
- a collection of objects to check.type
- the type of object to find.public static java.util.Collection getObjectsByType(java.util.Collection objects, EClassifier type)
is an instance
of the type.objects
- a collection of objects to check.type
- the type of object to find.public static EObject copy(EObject eObject)
eObject
- the object to copy.EcoreUtil.Copier
public static java.util.Collection copyAll(java.util.Collection eObjects)
EObject
in eObjects.eObjects
- the collection of objects to copy.EcoreUtil.Copier
public static EObject getRootContainer(EObject eObject)
null
container
.
The root container must be directly contained
in a resource
for its tree
to be serializable
.
eObject
- the object to get the root container for.EObject.eResource()
,
EObject.eContainer()
public static boolean isAncestor(EObject ancestorEObject, EObject eObject)
content tree
of the first.ancestorEObject
- the ancestor object in question.eObject
- the object to test.EObject.eContainer()
public static boolean isAncestor(Resource ancestorResource, EObject eObject)
content tree
of the resource.ancestorResource
- the ancestor resource in question.eObject
- the object to test.EObject.eContainer()
,
EObject.eResource()
public static boolean isAncestor(ResourceSet ancestorResourceSet, EObject eObject)
content tree
of the resource set.ancestorResourceSet
- the ancestor resource set in question.eObject
- the object to test.EObject.eContainer()
,
EObject.eResource()
,
Resource.getResourceSet()
public static boolean isAncestor(java.util.Collection ancestorEMFObjects, EObject eObject)
ancestorEMFObjects
- the collection of ancestor objects in question.eObject
- the object to test.public static TreeIterator getAllContents(java.util.Collection emfObjects)
ResourceSet.getResources()
,
Resource.getContents()
,
and EObject.eContents()
.
It uses a special iterator for ResourceSet.getResources
that is tolerant of growth in the underlying collection
which result from demand loaded resources;
the iterator will walk these additional resources.emfObjects
- the collection of objects to iterate over.EcoreUtil.ContentTreeIterator
public static java.lang.String getIdentification(EObject eObject)
<java-class-name>[/<dynamic-eclass-name>]@<java-hex-hash-code>{<uri-of-eobject>}
eObject
- the object for which to get an identification.public static URI getURI(EObject eObject)
eObject
- the object for which to get the URI.public static void setEList(EList eList, java.util.Collection prototypeList)
eList
's contents and order to be exactly that of the prototype
collection.
This implementation mimimizes the number of notifications the operation will produce.
Objects already in the list will be moved, missing objects will be added, and extra objects will be removed.
If eList
's contents and order are already exactly that of the prototype
collection,
no change will be made.eList
- the list to set.prototype
- the collection representing the desired content and order.public static void remove(EStructuralFeature.Setting setting, java.lang.Object value)
setting
- the setting holding the value.value
- the value to remove.public static void replace(EStructuralFeature.Setting setting, java.lang.Object oldValue, java.lang.Object newValue)
setting
- the setting holding the values.oldValue
- the value to replace.newValue
- the replacement value.public static void remove(EObject eObject, EStructuralFeature eStructuralFeature, java.lang.Object value)
eObject
- the object holding the value.eStructuralFeature
- the feature of the object holding the value.value
- the value to remove.public static void replace(EObject eObject, EStructuralFeature eStructuralFeature, java.lang.Object oldValue, java.lang.Object newValue)
eObject
- the object holding the values.eStructuralFeature
- the feature of the object holding the values.oldValue
- the value to replace.newValue
- the replacement value.public static void remove(EObject eObject)
containing
resource
or its containing
object.eObject
- the object to remove.public static void replace(EObject eObject, EObject replacementEObject)
containing
resource
or its containing
object,
with the replacement object.eObject
- the object to replace.replacementEObject
- the replacement object.public static EObject create(EClass eClass)
eClass
- the class to instantiate.public static java.lang.Object createFromString(EDataType eDataType, java.lang.String literal)
eDataType
- the datatype to instantiate.literal
- the string value of the datatype.convertToString(EDataType, Object)
public static java.lang.String convertToString(EDataType eDataType, java.lang.Object value)
eDataType
- the datatype to instantiate.value
- a value of the datatype.createFromString(EDataType, String)
public static java.lang.String getID(EObject eObject)
null
.eObject
- the object in question.EAttribute.isID()
,
EClass.getEIDAttribute()
,
setID(EObject, String)
public static void setID(EObject eObject, java.lang.String id)
null
ID will unset the attribute rather than setting it to null
.eObject
- the object in question.id
- the String value of the new ID.java.lang.IllegalArgumentException
- if the object has no ID attribute.getID(EObject)
,
EAttribute.isID()
,
EClass.getEIDAttribute()
public static java.lang.Class wrapperClassFor(java.lang.Class javaClass)
javaClass
-
|
Copyright 2001-2003 IBM Corporation and others. All Rights Reserved. |
|||||||||
PREV CLASS SOURCE NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |