uk.ac.sheffield.vtts.model

Class Named

java.lang.Object

uk.ac.sheffield.vtts.model.Element

uk.ac.sheffield.vtts.model.Named

Direct Known Subclasses:

Annotated, Entity, Event, Expression

public abstract class Named
extends Element

Named is the ancestor of all named elements in the metamodel. By default, a named element is assumed to be uniquely identifiable by its name. The contract for equals expects two elements to have the same type and name to be judged equal.

Version:

Broker@Cloud 1.0

Author:

Anthony J H Simons

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	name The name attribute of a Named element.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Named() Creates a default Named element with no name.
protected	Named(java.lang.String name) Creates a Named element with the given name.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other) Reports whether this Named element is equal to another object.
java.lang.String	getName() Returns the name of a Named element.
int	hashCode() Returns a quasi-unique hash code for this named element.
Named	setName(java.lang.String name) Sets the name of a Named element.
Named	setName(java.lang.String name, boolean obligatory) Sets the name of a Named element to an obligatory name.
java.lang.String	toString() Converts this Named element to a printable representation.

Methods inherited from class uk.ac.sheffield.vtts.model.Element

safeEquals, safeHashCode, semanticError

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

The name attribute of a Named element.

Constructor Detail

Named

protected Named()

Creates a default Named element with no name.

Named

protected Named(java.lang.String name)

Creates a Named element with the given name. If a second name is later assigned, this must be the same name.

Parameters:

name - the name.

Method Detail

equals

public boolean equals(java.lang.Object other)

Reports whether this Named element is equal to another object. True, if the other object is a Named element, whose name is equal to the name of this object.

Overrides:

equals in class java.lang.Object

Parameters:

other - the other object.

Returns:

true, if both Named elements have the same name.

hashCode

public int hashCode()

Returns a quasi-unique hash code for this named element. Returns the hash code associated with the Named element's name. This method must be overridden in any subclass for which equality is not judged by name equality.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code for this Named element.

setName

public Named setName(java.lang.String name)

Sets the name of a Named element. This Named element may only be given one name and may not be renamed later with a different name.

Parameters:

name - the name to set.

Returns:

this Named element.

Throws:

SemanticError - if this Named element is renamed.

setName

public Named setName(java.lang.String name,
            boolean obligatory)

Sets the name of a Named element to an obligatory name. This Named element must have the given name. If it already has some other name, then this breaks a required correspondence in the model.

Parameters:

name - the name to set.

obligatory - the value true.

Returns:

this Named element.

Throws:

SemanticError - if this Named element has another name.

getName

public java.lang.String getName()

Returns the name of a Named element. Names are optional by default, but some subtypes insist on the presence of a name, for indexing purposes.

Returns:

the name, or null.

toString

public java.lang.String toString()

Converts this Named element to a printable representation. By default, returns the name of this Named element.

Overrides:

toString in class java.lang.Object

Returns:

the String representation of this Named element.