Module org.tquadrat.foundation.xml

Package org.tquadrat.foundation.xml.builder

Class Namespace

java.lang.Object

org.tquadrat.foundation.xml.builder.Namespace

All Implemented Interfaces:

Serializable, Comparable<Namespace>

@ClassVersion(sourceVersion="$Id: Namespace.java 1101 2024-02-18 00:18:48Z tquadrat $")
@API(status=STABLE,
     since="0.0.5")
public final class Namespace
extends Object
implements Serializable, Comparable<Namespace>

The definition of an XML namespace entry.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: Namespace.java 1101 2024-02-18 00:18:48Z tquadrat $

Since:

0.0.5

See Also:

• Serialized Form

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.xml.builder.Namespace"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
static final Namespace[]	EMPTY_Namespace_ARRAY	An empty array of Namespace objects.
static final String	KEYWORD	The keyword for a namespace definition: "xmlns".
private final URI	m_Identifier	The namespace identifier.
private final Optional<String>	m_Prefix	The namespace prefix.

Constructor Summary

Constructors

Modifier	Constructor	Description
	Namespace(String identifier)	Creates a new Namespace instance without a prefix.
	Namespace(String prefix, String identifier)	Creates a new Namespace instance. The given prefix is validated using the method that is provided by XMLBuilderUtils.getPrefixValidator().
	Namespace(String prefix, URI identifier)	Creates a new Namespace instance. The given prefix is validated using the method that is provided by XMLBuilderUtils.getPrefixValidator().
	Namespace(URI identifier)	Creates a new Namespace instance without a prefix.
private	Namespace(Optional<String> prefix, URI identifier)	Creates a new Namespace instance. The given prefix is validated using the method that is provided by XMLBuilderUtils.getPrefixValidator().

Method Summary

Modifier and Type	Method	Description
final int	compareTo(Namespace o)
final boolean	equals(Object obj)
final URI	getIdentifier()	Returns the namespace identifier.
final Optional<String>	getPrefix()	Returns the namespace prefix.
final int	hashCode()
final String	toString()

Methods inherited from class java.lang.Object

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

Field Details

EMPTY_Namespace_ARRAY

public static final Namespace[] EMPTY_Namespace_ARRAY

An empty array of Namespace objects.

KEYWORD

public static final String KEYWORD

The keyword for a namespace definition: "xmlns".

See Also:

• Constant Field Values

m_Identifier

private final URI m_Identifier

The namespace identifier.

m_Prefix

private final Optional<String> m_Prefix

The namespace prefix.

Constructor Details

Namespace

public Namespace(URI identifier)

Creates a new Namespace instance without a prefix.

Parameters:

identifier - The namespace identifier.

Namespace

public Namespace(String identifier)
          throws URISyntaxException

Creates a new Namespace instance without a prefix.

Parameters:

identifier - The namespace identifier.

Throws:

URISyntaxException - The provided URI String is invalid.

Namespace

public Namespace(String prefix,
 URI identifier)

Creates a new Namespace instance.

The given prefix is validated using the method that is provided by XMLBuilderUtils.getPrefixValidator().

Parameters:

prefix - The namespace prefix.

identifier - The namespace identifier.

Namespace

public Namespace(String prefix,
 String identifier)
          throws URISyntaxException

Creates a new Namespace instance.

The given prefix is validated using the method that is provided by XMLBuilderUtils.getPrefixValidator().

Parameters:

prefix - The namespace prefix.

identifier - The namespace identifier.

Throws:

URISyntaxException - The provided URI String is invalid.

Namespace

private Namespace(Optional<String> prefix,
 URI identifier)

Creates a new Namespace instance.

The given prefix is validated using the method that is provided by XMLBuilderUtils.getPrefixValidator().

Parameters:

prefix - The namespace prefix.

identifier - The namespace identifier.

Method Details

compareTo

public final int compareTo(Namespace o)

Specified by:

compareTo in interface Comparable<Namespace>

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

getIdentifier

public final URI getIdentifier()

Returns the namespace identifier.

Returns:

The namespace identifier.

getPrefix

public final Optional<String> getPrefix()

Returns the namespace prefix.

Returns:

An instance of Optional that holds the namespace prefix.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public final String toString()

Overrides:

toString in class Object