org.openbase.jul.extension.protobuf

Class IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

java.lang.Object

org.openbase.jul.extension.protobuf.IdentifiableMessage<KEY,M,MB>

Type Parameters:

KEY - ID Type

M - Internal Message

MB -

All Implemented Interfaces:

MessageContainer<M>, Identifiable<KEY>

public class IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>
extends Object
implements Identifiable<KEY>, MessageContainer<M>

Author:

Divine Threepwood

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger

Fields inherited from interface org.openbase.jul.iface.Identifiable

TYPE_FIELD_ID

Constructor Summary

Constructors

Constructor and Description
IdentifiableMessage(IdentifiableMessage<KEY,M,MB> identifiableMessage) Copy Constructor
IdentifiableMessage(M message)
IdentifiableMessage(M message, IdGenerator<KEY,M> idGenerator)

Method Summary

Modifier and Type	Method and Description
void	addObserver(org.openbase.jul.pattern.Observer<IdentifiableMessage<KEY,M,MB>> observer)
boolean	equals(Object obj)
String	generateMessageDescription() Method generates a short string description of the internal message.
KEY	getId()
M	getMessage()
String	getMessageTypeName()
int	hashCode()
void	notifyObservers()
void	removeObserver(org.openbase.jul.pattern.Observer<IdentifiableMessage<KEY,M,MB>> observer)
IdentifiableMessage<KEY,M,MB>	setMessage(M message)
IdentifiableMessage<KEY,M,MB>	setMessage(MB builder)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

Constructor Detail

IdentifiableMessage

public IdentifiableMessage(IdentifiableMessage<KEY,M,MB> identifiableMessage)
                    throws InstantiationException

Copy Constructor

Parameters:

identifiableMessage -

Throws:

InstantiationException

IdentifiableMessage

public IdentifiableMessage(M message,
                           IdGenerator<KEY,M> idGenerator)
                    throws InstantiationException

Throws:

InstantiationException

IdentifiableMessage

public IdentifiableMessage(M message)
                    throws InstantiationException

Throws:

InstantiationException

Method Detail

getId

public KEY getId()
          throws NotAvailableException

Specified by:

getId in interface Identifiable<KEY>

Throws:

NotAvailableException

setMessage

public IdentifiableMessage<KEY,M,MB> setMessage(MB builder)
                                         throws CouldNotPerformException

Throws:

CouldNotPerformException

setMessage

public IdentifiableMessage<KEY,M,MB> setMessage(M message)
                                         throws CouldNotPerformException

Throws:

CouldNotPerformException

notifyObservers

public void notifyObservers()

getMessage

public M getMessage()

Specified by:

getMessage in interface MessageContainer<M extends com.google.protobuf.GeneratedMessage>

getMessageTypeName

public String getMessageTypeName()

addObserver

public void addObserver(org.openbase.jul.pattern.Observer<IdentifiableMessage<KEY,M,MB>> observer)

removeObserver

public void removeObserver(org.openbase.jul.pattern.Observer<IdentifiableMessage<KEY,M,MB>> observer)

toString

public String toString()

Overrides:

toString in class Object

generateMessageDescription

public String generateMessageDescription()

Method generates a short string description of the internal message. This description is bases on internal message fields like label or id provided by the message itself. If non of this fields could be detected a ? char is returned.

Returns:

a short description of the message as string.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object