src/net/java/sip/communicator/service/replacement/ReplacementService.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

/*
 * SIP Communicator, the OpenSource Java VoIP and Instant Messaging client.
 * 
 * Distributable under LGPL license. See terms of license at gnu.org.
 */
package net.java.sip.communicator.service.replacement;

/**
 * A service used to provide substitution for any text in chat messages, like
 * smileys, video and image previews, etc.
 * 
 * @author Purvesh Sahoo
 */
public interface ReplacementService
{
    /**
     * The source name property name.
     */
    public final String SOURCE_NAME = "SOURCE";

    /**
     * Returns the chat message with the text replacements if any or returns the
     * original chat message.
     * 
     * @param chatString the original chat message.
     * @return the replaced chat message in case of match; the original message
     *         in case of no match.
     */
    public String getReplacedMessage(String chatString);

    /**
     * Returns the name of the replacement source.
     * 
     * @return the replacement source name
     */
    public String getSourceName();
}