com.prosysopc.ua.pubsub

Class PublisherId

java.lang.Object

com.prosysopc.ua.pubsub.PublisherId

public final class PublisherId
extends Object

Defines an OPC UA PubSub PublisherId. It is an unique identifier for a Publisher within a Network. Valid types for the id are String and unsigned integer types: UnsignedByte, UnsignedShort, UnsignedInteger and UnsignedLong. Instances are immutable and constructed via static factory methods.

Per OPC UA Specification, 1.05.01 Part 14 section 6.2.7.1. null or empty String is not valid nor is 0 for integer types. Specifically should be noted, that different PublisherId types of the same numerical value are not equal i.e. UnsignedShort 1 is not equal to UnsignedInteger 1.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PublisherId.Type Enum defining different types of PublisherIds.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
PublisherId.Type	getType() Returns the type of the PublisherId, not null.
Object	getValue() Returns the value of the id.
int	hashCode()
static PublisherId	of(PublisherId.Type type, Object value)
static PublisherId	of(String value)
static PublisherId	of(UnsignedByte value)
static PublisherId	of(UnsignedInteger value)
static PublisherId	of(UnsignedLong value)
static PublisherId	of(UnsignedShort value)
static PublisherId	parse(String value) Parses the given string (must be equals to the toString() output) to PublisherId.
static PublisherId	raw(Object value) Returns a PublisherId with the given value.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

of

public static PublisherId of(String value)

of

public static PublisherId of(PublisherId.Type type,
                             Object value)

of

public static PublisherId of(UnsignedByte value)

of

public static PublisherId of(UnsignedInteger value)

of

public static PublisherId of(UnsignedLong value)

of

public static PublisherId of(UnsignedShort value)

parse

public static PublisherId parse(String value)

Parses the given string (must be equals to the toString() output) to PublisherId. If the given String doesn't contain the "type:value" type prefix it is interpreted as a String. If the type is unknown the whole input is interpreted as a String PublisherId (with a WARN log).

raw

public static PublisherId raw(Object value)

Returns a PublisherId with the given value. Throws IllegalArgumentException if the type is not of valid types or is null or invalid value.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getType

public PublisherId.Type getType()

Returns the type of the PublisherId, not null.

getValue

public Object getValue()

Returns the value of the id. Is one of String and unsigned integer types: UnsignedByte, UnsignedShort, UnsignedInteger or UnsignedLong. The returned value shall be a valid PublisherId and thus not null nor an empty String nor 0 (for integer types).

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object