org.ws4d.java.types
Class QName

java.lang.Object
  org.ws4d.java.types.QName

public class QName
extends java.lang.Object

Class wraps all information of a qualified name, which are:

• port type
• namespace
• prefix - is the prefix fixed or only a suggestion (change is allowed later on)
• priority - for DPWS discovery

Notice

All created qualified names will be used for DPWS discovery. Sets the priority while creating a qualified name. Set priority to QNAME_WITHOUT_PRIORITY to omit this qualified name on DPWS discovery.

Field Summary

static int	QNAME_WITH_PRIORITY
static int	QNAME_WITHOUT_PRIORITY

Constructor Summary

QName(java.lang.String localPart)
Constructs a qualified name object with set port type.

QName(java.lang.String localPart, java.lang.String namespace)
Constructs a qualified name object with set port type, namespace name.

QName(java.lang.String localPart, java.lang.String namespace, int priority)
Constructs a qualified name object with set port type, namespace name, namespace prefix and DPWS discovery priority.

QName(java.lang.String localPart, java.lang.String namespace, java.lang.String prefix)
Constructs a qualified name object with set port type, namespace name and namespace prefix.

QName(java.lang.String localPart, java.lang.String namespace, java.lang.String prefix, int priority)
Constructs a qualified name object with set port type, namespace name, namespace prefix and DPWS discovery priority.

Method Summary

static QName	construct(java.lang.String nsAndLocalPart) Constructs a qualified name object with given namespace name and port type.
boolean	equalNamespaceAndPrefix(QName qn) Compares this qualified name to specified one.
boolean	equals(java.lang.Object o)
boolean	equals(QName qn) Compares this qualified name to specified one.
boolean	equals(java.lang.String localPart, java.lang.String namespace) Compares this qualified name to specified port type and namespace name.
java.lang.String	getLocalPart() Returns the port type without prefix.
java.lang.String	getLocalPartPrefixed() Returns the port type with prefix.
java.lang.String	getNamespace() Returns the namespace name without prefix.
java.lang.String	getNamespacePrefixed() Returns the namespace name with prefix.
java.lang.String	getPrefix() Returns the prefix.
int	getPriority()
int	hashCode()
boolean	hasPriority()
void	setPrefix(java.lang.String prefix) Sets the prefix.
void	setPriority(int priority)
java.lang.String	toString()
java.lang.String	toStringPlain()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

QNAME_WITHOUT_PRIORITY

public static final int QNAME_WITHOUT_PRIORITY

See Also:

Constant Field Values

QNAME_WITH_PRIORITY

public static final int QNAME_WITH_PRIORITY

See Also:

Constant Field Values

Constructor Detail

QName

public QName(java.lang.String localPart)

Constructs a qualified name object with set port type.

This qualified name WILL be used for DPWS discovery! This qualified name has normal priority. Use QName(String, String, int) if a priority change is necessary.

Parameters:

localPart - Port type.

namespace - namespace name.

QName

public QName(java.lang.String localPart,
             java.lang.String namespace)

Constructs a qualified name object with set port type, namespace name.

This qualified name WILL be used for DPWS discovery! This qualified name has normal priority. Use QName(String, String, int) if a priority change is necessary.

Parameters:

localPart - Port type.

namespace - namespace name.

QName

public QName(java.lang.String localPart,
             java.lang.String namespace,
             int priority)

Constructs a qualified name object with set port type, namespace name, namespace prefix and DPWS discovery priority.

This qualified name CAN be used for DPWS discovery! Set priority to QNAME_WITHOUT_PRIORITY if this qualified name SHOULD NOT be used in DPWS discovery.

Parameters:

localPart - Port type.

namespace - namespace name.

priority - indicates whether this qualified name should be used for DPWS discovery or not.

QName

public QName(java.lang.String localPart,
             java.lang.String namespace,
             java.lang.String prefix)

Constructs a qualified name object with set port type, namespace name and namespace prefix.

This qualified name WILL be used for DPWS discovery! This qualified name has normal priority. Use QName(String, String, String, int) if a priority change is necessary.

Parameters:

localPart - Port type.

namespace - namespace name.

prefix - namespace prefix.

QName

public QName(java.lang.String localPart,
             java.lang.String namespace,
             java.lang.String prefix,
             int priority)

Constructs a qualified name object with set port type, namespace name, namespace prefix and DPWS discovery priority.

This qualified name CAN be used for DPWS discovery! Set priority to QNAME_WITHOUT_PRIORITY if this qualified name SHOULD NOT be used in DPWS discovery.

Parameters:

localPart - Port type.

namespace - namespace name.

prefix - namespace prefix.

priority - indicates whether this qualified name should be used for DPWS discovery or not.

Method Detail

construct

public static QName construct(java.lang.String nsAndLocalPart)

Constructs a qualified name object with given namespace name and port type.

Parameters:

nsAndLocalPart - namespace name and port type divided by '/'.

Returns:

Constructed QualifiedName or null.

getLocalPart

public java.lang.String getLocalPart()

Returns the port type without prefix.

Returns:

Port type.

getLocalPartPrefixed

public java.lang.String getLocalPartPrefixed()

Returns the port type with prefix.

Returns:

Port type.

getNamespace

public java.lang.String getNamespace()

Returns the namespace name without prefix.

Returns:

namespace name.

getNamespacePrefixed

public java.lang.String getNamespacePrefixed()

Returns the namespace name with prefix.

Returns:

namespace name.

getPrefix

public java.lang.String getPrefix()

Returns the prefix.

Returns:

The prefix.

setPrefix

public void setPrefix(java.lang.String prefix)

Sets the prefix.

Parameters:

prefix - Prefix to set.

equals

public final boolean equals(QName qn)

Compares this qualified name to specified one. Based on port type and namespace name.

Parameters:

qn - Qualified name to compare with.

Returns:

true if equal, false otherwise.

equals

public final boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

equals

public final boolean equals(java.lang.String localPart,
                            java.lang.String namespace)

Compares this qualified name to specified port type and namespace name.

Parameters:

localPart - Port type.

namespace - namespace name.

Returns:

true if equal, false otherwise.

equalNamespaceAndPrefix

public boolean equalNamespaceAndPrefix(QName qn)

Compares this qualified name to specified one. Based on namespace name and prefix.

Parameters:

qn - Qualified name to compare with.

Returns:

true if equal, false otherwise.

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringPlain

public final java.lang.String toStringPlain()

setPriority

public final void setPriority(int priority)

getPriority

public final int getPriority()

hasPriority

public final boolean hasPriority()