hudson.plugins.sametime.im

Interface IMMessageTargetConverter

All Known Implementing Classes:

DefaultIMMessageTargetConverter, SametimeIMMessageTargetConverter

public interface IMMessageTargetConverter

A IMMessageTargetConverter has the responsibility of creating a IMMessageTarget from a String and back. It will be used to create IMMessageTargets from user input and to display them back through the GUI. Note that fromString and toString should be at least semantically symetric.

Author:

Uwe Schaefer

Method Summary

Methods

Modifier and Type	Method and Description
IMMessageTarget	fromString(String targetAsString) creates a IMMessageTarget from the given String.
String	toString(IMMessageTarget target) Turns given IMMessageTarget into a String for GUI-Display.

Method Detail

fromString

IMMessageTarget fromString(String targetAsString)
                           throws IMMessageTargetConversionException

creates a IMMessageTarget from the given String.

Parameters:

targetAsString - can be null

Returns:

might return null, if input was null or an empty String

Throws:

IMMessageTargetConversionException

toString

String toString(IMMessageTarget target)

Turns given IMMessageTarget into a String for GUI-Display.

Parameters:

target - must not be null

Returns:

String representation of the target