fr.inria.atlanmod.neoemf.data.structure

Class ContainerInfo

java.lang.Object

fr.inria.atlanmod.neoemf.data.structure.ContainerInfo

All Implemented Interfaces:

Serializable

public class ContainerInfo
extends Object
implements Serializable

A simple representation of a containment between a PersistentEObject and another. The referenced PersistentEObject is identified by the name the reference used to retrieve it.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ContainerInfo(Id id, String name) Constructs a new ContainerInfo with the given id and the given name.

Method Summary

Modifier and Type	Method and Description
static ContainerInfo	from(PersistentEObject object, EReference reference) Creates a new ContainerInfo from the given object and reference.
Id	id() Returns the identifier of the PersistentEObject.
String	name() Returns the name the EReference used to retrieve the container of the PersistentEObject.
static ContainerInfo	of(Id id, String name) Creates a new ContainerInfo with the given id and name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContainerInfo

protected ContainerInfo(@Nonnull
                        Id id,
                        @Nonnull
                        String name)

Constructs a new ContainerInfo with the given id and the given name.

Parameters:

id - the identifier of the PersistentEObject

name - the name the reference used to retrieve the container of the PersistentEObject

Method Detail

from

@Nonnull
public static ContainerInfo from(@Nonnull
                                           PersistentEObject object,
                                           @Nonnull
                                           EReference reference)

Creates a new ContainerInfo from the given object and reference.

This method behaves like: of(object.id(), reference.getName()).

Parameters:

object - the PersistentEObject

reference - the reference used to retrieve the container of the PersistentEObject

Returns:

a new ContainerInfo

See Also:

of(Id, String)

of

@Nonnull
public static ContainerInfo of(@Nonnull
                                         Id id,
                                         @Nonnull
                                         String name)

Creates a new ContainerInfo with the given id and name.

Parameters:

id - the identifier of the PersistentEObject

name - the name the reference used to retrieve the container of the PersistentEObject

Returns:

a new ContainerInfo

id

@Nonnull
public Id id()

Returns the identifier of the PersistentEObject.

Returns:

the identifier of the object

name

@Nonnull
public String name()

Returns the name the EReference used to retrieve the container of the PersistentEObject.

Returns:

the name of the reference