Package com.atlassian.confluence.api.model.messages

Class SimpleMessage

java.lang.Object

com.atlassian.confluence.api.model.messages.SimpleMessage

All Implemented Interfaces:

Message<SimpleMessage>, Comparable<SimpleMessage>

@ExperimentalApi
public class SimpleMessage
extends Object
implements Message<SimpleMessage>

Simple immutable implementation of Message.

Since:

5.6

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SimpleMessage.SimpleMessageBuilder

Method Summary

Modifier and Type	Method	Description
static SimpleMessage.SimpleMessageBuilder	builder()
static SimpleMessage	copyOf(Message message)
boolean	equals(Object obj)
Object[]	getArgs()
String	getKey()
String	getTranslation()
int	hashCode()
String	toString()
static SimpleMessage	withKeyAndArgs(String key, Object... args)	Creates a new SimpleMessage with the given key and arguments.
static SimpleMessage	withTranslation(String translation)	Used when a message only has a translated string at creation time, usually in English.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.api.model.messages.Message

compareTo

Method Detail

builder

public static SimpleMessage.SimpleMessageBuilder builder()

withKeyAndArgs

public static SimpleMessage withKeyAndArgs(String key,
                                           Object... args)

Creates a new SimpleMessage with the given key and arguments.

withTranslation

public static SimpleMessage withTranslation(String translation)

Used when a message only has a translated string at creation time, usually in English.

Use of this method is discouraged - try to use withKeyAndArgs(String, Object...) whenever possible.

getKey

public String getKey()

Specified by:

getKey in interface Message<SimpleMessage>

Returns:

the i18n key of this message

getArgs

public Object[] getArgs()

Specified by:

getArgs in interface Message<SimpleMessage>

Returns:

the arguments to this message. May be null or an empty array.

getTranslation

public String getTranslation()

Specified by:

getTranslation in interface Message<SimpleMessage>

Returns:

the translated message, may be null if this message has not been translated yet.

copyOf

public static SimpleMessage copyOf(Message message)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object