org.modelio.vbasic.version

Class VersionedItem<T>

java.lang.Object

org.modelio.vbasic.version.VersionedItem<T>

Type Parameters:

T - the attached data type.

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<VersionedItem<?>>

public class VersionedItem<T>
extends java.lang.Object
implements java.lang.Comparable<VersionedItem<?>>, java.io.Serializable

Represents a versioned item.

It is composed of a name identifying it and a version. Only these fields are used for equality and comparisons.

The represented object or any other data may be attached by the setObject(Object) relation.

Author:

cmarin

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
VersionedItem(java.lang.String name, Version version)
VersionedItem(java.lang.String name, Version version, T object)

Method Summary

Modifier and Type	Method and Description
int	compareTo(VersionedItem<?> o)
boolean	equals(java.lang.Object obj)
static <T> VersionedItem<T>	find(java.lang.String name, java.util.Collection<VersionedItem<T>> coll) Convenience to find a versioned item by name in a generic collection.
java.lang.String	getName()
T	getObject() Get the represented object, or any data attached.
Version	getVersion()
int	hashCode()
void	setObject(T object) Attach the represented object or any other data.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VersionedItem

public VersionedItem(java.lang.String name,
                     Version version,
                     T object)

Parameters:

name - the item name

version - the item version

object - the represented object

VersionedItem

public VersionedItem(java.lang.String name,
                     Version version)

Parameters:

name - the name

version - the version

Method Detail

compareTo

public int compareTo(VersionedItem<?> o)

Specified by:

compareTo in interface java.lang.Comparable<VersionedItem<?>>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

find

public static <T> VersionedItem<T> find(java.lang.String name,
                                        java.util.Collection<VersionedItem<T>> coll)

Convenience to find a versioned item by name in a generic collection.

Parameters:

name - the name to look for

coll - the collection to look into

Returns:

the found item or null.

getName

public java.lang.String getName()

Returns:

the name

getObject

public T getObject()

Get the represented object, or any data attached.

Returns:

the object

getVersion

public Version getVersion()

Returns:

the version

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

setObject

public void setObject(T object)

Attach the represented object or any other data.

Parameters:

object - the object to attach.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object