src/net/java/sip/communicator/service/replacement/smilies/Smiley.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
38
39
40
41
42
43
44
45
46
47
48
49

/*
 * Jitsi, 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.smilies;

import java.util.*;

/**
 * The <tt>Smiley</tt> interface used to represent a smiley
 *
 * @author Yana Stamcheva
 */
public interface Smiley
{
    /**
     * Returns the description of this smiley.
     *
     * @return the description of this smiley.
     */
    public String getDescription();

    /**
     * Returns the set of Strings corresponding to this smiley.
     * @return the set of Strings corresponding to this smiley.
     */
    public List<String> getSmileyStrings();

    /**
     * Returns the default String corresponding for this smiley. For example
     * ":-)".
     * @return the default String corresponding for this smiley.
     */
    public String getDefaultString();

    /**
     * Returns the identifier of the image corresponding to this smiley.
     * @return the identifier of the image corresponding to this smiley.
     */
    public String getImageID();

    /**
     * Returns the path of the image corresponding to this smiley.
     * @return the path of the image corresponding to this smiley.
     */
    public String getImagePath();
}