Class DefaultScopedName

Object

AbstractName

DefaultScopedName

All Implemented Interfaces:

Serializable, Comparable<Generic­Name>, Generic­Name, Scoped­Name

public class DefaultScopedName
extends AbstractName
implements ScopedName

A composite of a name space (as a local name) and a generic name valid in that name space. See the GeoAPI javadoc for more information.

Default­Scoped­Name can be instantiated by any of the following methods:

• Default­Name­Factory.create­Generic­Name(Name­Space, Char­Sequence[]) with an array of length 2 or more.
• Default­Name­Factory.parse­Generic­Name(Name­Space, Char­Sequence) with at least one occurrence of the separator in the path.
• Similar static convenience methods in Names.

Immutability and thread safety

This class is immutable and thus inherently thread-safe if the Name­Space and all Char­Sequence elements in the arguments given to the constructor are also immutable. Subclasses shall make sure that any overridden methods remain safe to call from multiple threads and do not change any public Local­Name state.

Since:

0.3

See Also:

• Default­Name­Space
• Default­Local­Name
• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Default­Scoped­Name(Generic­Name path, String separator, Char­Sequence tail)	Constructs a scoped name as the concatenation of the given generic name with a single character sequence.
protected	Default­Scoped­Name(Generic­Name path, Generic­Name tail)	Constructs a scoped name as the concatenation of the given generic names.
protected	Default­Scoped­Name(Name­Space scope, List<? extends Char­Sequence> names)	Constructs a scoped name from the specified list of strings.

Method Summary

Modifier and Type	Method	Description
List<? extends Local­Name>	get­Parsed­Names()	Returns the sequence of local name for this generic name.
Generic­Name	path()	Returns every element in the sequence of parsed names except for the tip.
Generic­Name	tail()	Returns every elements in the sequence of parsed names except for the head.

Methods inherited from class AbstractName

cast­Or­Copy, compare­To, depth, equals, hash­Code, head, push, tip, to­Fully­Qualified­Name, to­International­String, to­String

Modifier and Type	Method	Description
static Abstract­Name	cast­Or­Copy(Generic­Name object)	Returns a SIS name implementation with the values of the given arbitrary implementation.
int	compare­To(Generic­Name name)	Compares this name with the specified name for order.
int	depth()	Indicates the number of levels specified by this name.
boolean	equals(Object object)	Compares this generic name with the specified object for equality.
int	hash­Code()	Returns a hash code value for this generic name.
Local­Name	head()	Returns the first element in the sequence of parsed names.
Scoped­Name	push(Generic­Name scope)	Returns this name expanded with the specified scope.
Local­Name	tip()	Returns the last element in the sequence of parsed names.
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.
String	to­String()	Returns a string representation of this generic name.

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Methods inherited from interface ScopedName

head, tip, to­String

Modifier and Type	Method	Description
Local­Name	head()	Returns the first element in the sequence of parsed names.
Local­Name	tip()	Returns the last element in the sequence of parsed names.
String	to­String()	Returns a locale-independent string representation of this scoped name.

Constructor Details

DefaultScopedName

protected DefaultScopedName(NameSpace scope,
 List<? extends CharSequence> names)

Constructs a scoped name from the specified list of strings. If any of the given names is an instance of International­String, then its to­String(Locale.ROOT) method will be invoked for fetching an unlocalized name. Otherwise the Char­Sequence.to­String() method will be used.

Parameters:

scope - the scope of this name, or null for the global scope.

names - the local names. This list must have at least two elements.

DefaultScopedName

protected DefaultScopedName(GenericName path,
 GenericName tail)

Constructs a scoped name as the concatenation of the given generic names. The scope of the new name will be the scope of the path argument.

Parameters:

path - the first part to concatenate.

tail - the second part to concatenate.

DefaultScopedName

protected DefaultScopedName(GenericName path,
 String separator,
 CharSequence tail)

Constructs a scoped name as the concatenation of the given generic name with a single character sequence. The scope of the new name will be the scope of the path argument. The tail is a local name created from the given character sequence.

Parameters:

path - the first part to concatenate.

separator - the separator between the head and the tail, or null for inheriting the same separator as the given path.

tail - the second part to concatenate.

Since:

0.8

See Also:

• Names.create­Scoped­Name(Generic­Name, String, Char­Sequence)

Method Details

tail

public GenericName tail()

Returns every elements in the sequence of parsed names except for the head.

Specified by:

tail in interface Scoped­Name

Returns:

all elements except the first one in the in the list of parsed names.

path

public GenericName path()

Returns every element in the sequence of parsed names except for the tip.

Specified by:

path in interface Scoped­Name

Returns:

all elements except the last one in the in the list of parsed names.

getParsedNames

public List<? extends LocalName> getParsedNames()

Returns the sequence of local name for this generic name.

Specified by:

get­Parsed­Names in interface Generic­Name

Specified by:

get­Parsed­Names in class Abstract­Name

Returns:

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