io.openems.common.types

Class ChannelAddress

java.lang.Object

io.openems.common.types.ChannelAddress

All Implemented Interfaces:

java.lang.Comparable<ChannelAddress>

public class ChannelAddress
extends java.lang.Object
implements java.lang.Comparable<ChannelAddress>

Constructor Summary

Constructors

Constructor and Description
ChannelAddress(java.lang.String componentId, java.lang.String channelId)

Method Summary

Modifier and Type	Method and Description
int	compareTo(ChannelAddress other)
boolean	equals(java.lang.Object obj)
static ChannelAddress	fromString(java.lang.String address) Parses a string "Component-ID/Channel-ID" to a ChannelAddress.
java.lang.String	getChannelId() Gets the Channel-Id.
java.lang.String	getComponentId() Gets the Component-ID.
int	hashCode()
static int	match(ChannelAddress source, ChannelAddress pattern) Match two ChannelAddresses, considering wildcards.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelAddress

public ChannelAddress(java.lang.String componentId,
                      java.lang.String channelId)

Method Detail

getComponentId

public java.lang.String getComponentId()

Gets the Component-ID.

Returns:

the Component-ID

getChannelId

public java.lang.String getChannelId()

Gets the Channel-Id.

Returns:

the Channel-Id

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

fromString

public static ChannelAddress fromString(java.lang.String address)
                                 throws OpenemsError.OpenemsNamedException

Parses a string "Component-ID/Channel-ID" to a ChannelAddress.

Parameters:

address - the address as a String

Returns:

the ChannelAddress

Throws:

OpenemsError.OpenemsNamedException - on parse error

compareTo

public int compareTo(ChannelAddress other)

Specified by:

compareTo in interface java.lang.Comparable<ChannelAddress>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

match

public static int match(ChannelAddress source,
                        ChannelAddress pattern)

Match two ChannelAddresses, considering wildcards.

• if equals(Object) is true -> return 0
• if both ChannelAddresses match via wildcards -> return value > 1; bigger values represent a better match
• if both ChannelAddresses do not match -> return -1

See StringUtils.matchWildcard(String, String) for implementation details.

Parameters:

source - the source ChannelAddress

pattern - the pattern ChannelAddress

Returns:

an integer value representing the degree of matching