Interface LocalName

All Superinterfaces:

Comparable<Generic­Name>, Generic­Name

All Known Subinterfaces:

Member­Name, Type­Name

All Known Implementing Classes:

Default­Local­Name, Default­Member­Name, Default­Type­Name

@UML(identifier="LocalName",
     specification=ISO_19103)
public interface LocalName
extends GenericName

Identifier within a name space for a local object. Local names are names which are directly accessible to and maintained by a name space. Names are local to one and only one name space. The name space within which they are local is indicated by the scope.

Since:

2.0

See Also:

• Name­Factory.create­Local­Name(Name­Space, Char­Sequence)

Method Summary

Modifier and Type	Method	Description
int	depth()	Returns the depth, which is always 1 for a local name.
List<? extends Local­Name>	get­Parsed­Names()	Returns the sequence of local name.
Local­Name	head()	Returns this since this object is already a local name.
Local­Name	tip()	Returns this since this object is already a local name.
String	to­String()	Returns a locale-independent string representation of this local name.

Methods inherited from interface Comparable

compare­To

Methods inherited from interface GenericName

push, scope, to­Fully­Qualified­Name, to­International­String

Modifier and Type	Method	Description
Scoped­Name	push(Generic­Name scope)	Returns this name expanded with the specified scope.
Name­Space	scope()	Returns the scope (name space) in which this name is local.
Generic­Name	to­Fully­Qualified­Name()	Returns a view of this name as a fully-qualified name.
International­String	to­International­String()	Returns a local-dependent string representation of this generic name.

Method Details

depth

int depth()

Returns the depth, which is always 1 for a local name.

Specified by:

depth in interface Generic­Name

Returns:

The depth of this name.

getParsedNames

@UML(identifier="parsedName",
     obligation=MANDATORY,
     specification=ISO_19103)
List<? extends LocalName> getParsedNames()

Returns the sequence of local name. Since this object is itself a locale name, this method always returns a singleton containing only this.

Specified by:

get­Parsed­Names in interface Generic­Name

Returns:

The local names making this generic name, without the scope. Shall never be null neither empty.

head

LocalName head()

Returns this since this object is already a local name.

Specified by:

head in interface Generic­Name

Returns:

The first element in the list of parsed names.

Since:

2.2

tip

LocalName tip()

Returns this since this object is already a local name.

Specified by:

tip in interface Generic­Name

Returns:

The last element in the list of parsed names.

Since:

2.1

toString

@UML(identifier="aName",
     obligation=MANDATORY,
     specification=ISO_19103)
String toString()

Returns a locale-independent string representation of this local name.

Specified by:

to­String in interface Generic­Name

Overrides:

to­String in class Object

Returns:

A local-independent string representation of this name.