Package org.openhab.core.common

Class AbstractUID

java.lang.Object

org.openhab.core.common.AbstractUID

Direct Known Subclasses:

MetadataKey, UID

@NonNullByDefault
public abstract class AbstractUID
extends Object

A non specific base class for unique identifiers.

Author:

Markus Rathgeb - Initial contribution

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SEGMENT_PATTERN
static final String	SEPARATOR

Constructor Summary

Constructors

Constructor	Description
AbstractUID()	Constructor must be public, otherwise it can not be called by subclasses from another package.
AbstractUID(String uid)	Parses a UID for a given string.
AbstractUID(String... segments)	Creates an AbstractUID for a list of segments.
AbstractUID(List<String> segments)	Creates a UID for list of segments.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object obj)
protected List<String>	getAllSegments()
String	getAsString()
protected abstract int	getMinimalNumberOfSegments()	Specifies how many segments the UID has to have at least.
protected String	getSegment(int segment)
int	hashCode()
String	toString()
protected void	validateSegment(String segment, int index, int length)

Methods inherited from class java.lang.Object

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

Field Details

SEGMENT_PATTERN

public static final String SEGMENT_PATTERN

See Also:

• Constant Field Values

SEPARATOR

public static final String SEPARATOR

See Also:

• Constant Field Values

Constructor Details

AbstractUID

public AbstractUID()

Constructor must be public, otherwise it can not be called by subclasses from another package.

AbstractUID

public AbstractUID(String uid)

Parses a UID for a given string. The UID must be in the format 'bindingId:segment:segment:...'.

Parameters:

uid - uid in form a string

AbstractUID

public AbstractUID(String... segments)

Creates an AbstractUID for a list of segments.

Parameters:

segments - the id segments

AbstractUID

public AbstractUID(List<String> segments)

Creates a UID for list of segments.

Parameters:

segments - segments

Method Details

getMinimalNumberOfSegments

protected abstract int getMinimalNumberOfSegments()

Specifies how many segments the UID has to have at least.

Returns:

the number of segments

getAllSegments

protected List<String> getAllSegments()

getSegment

protected String getSegment(int segment)

validateSegment

protected void validateSegment(String segment,
 int index,
 int length)

toString

public String toString()

Overrides:

toString in class Object

getAsString

public String getAsString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Object