com.comphenix.xp.messages

Class MessageFormatter

java.lang.Object

com.comphenix.xp.messages.MessageFormatter

public class MessageFormatter
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
MessageFormatter()
MessageFormatter(org.bukkit.entity.Player player, java.util.Collection<ResourceHolder> result)
MessageFormatter(org.bukkit.entity.Player player, java.util.Collection<ResourceHolder> result, java.lang.Integer count)

Method Summary

Methods

Modifier and Type	Method and Description
MessageFormatter	add(MessageFormatter other) Adds every parameter in both message formatters, creating a new message formatter with the results.
static MessageFormatter	add(MessageFormatter a, MessageFormatter b) Adds every parameter in both message formatters.
MessageFormatter	createView(java.util.Collection<ResourceHolder> result)
MessageFormatter	createView(org.bukkit.entity.Player player, java.util.Collection<ResourceHolder> result)
MessageFormatter	createView(org.bukkit.entity.Player player, java.util.Collection<ResourceHolder> result, java.lang.Integer count)
java.lang.String	formatMessage(java.lang.String message) Replaces parameters in the text with their respective value.
java.lang.Integer	getCount()
java.util.Collection<ResourceHolder>	getResult() Retrieves the list of resources awarded.
org.bukkit.entity.Player	getSource()
void	setCount(java.lang.Integer count)
void	setResult(java.util.Collection<ResourceHolder> result) Sets the list of resources awarded.
void	setSource(org.bukkit.entity.Player source)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageFormatter

public MessageFormatter()

MessageFormatter

public MessageFormatter(org.bukkit.entity.Player player,
                java.util.Collection<ResourceHolder> result)

MessageFormatter

public MessageFormatter(org.bukkit.entity.Player player,
                java.util.Collection<ResourceHolder> result,
                java.lang.Integer count)

Method Detail

formatMessage

public java.lang.String formatMessage(java.lang.String message)

Replaces parameters in the text with their respective value.

Parameters:

message - - message to format.

Returns:

Message with every parameter replaced with the corresponding value.

getCount

public java.lang.Integer getCount()

setCount

public void setCount(java.lang.Integer count)

getSource

public org.bukkit.entity.Player getSource()

setSource

public void setSource(org.bukkit.entity.Player source)

getResult

public java.util.Collection<ResourceHolder> getResult()

Retrieves the list of resources awarded.

Returns:

List of resources.

setResult

public void setResult(java.util.Collection<ResourceHolder> result)

Sets the list of resources awarded.

Parameters:

result - - the new list of resources awarded.

add

public static MessageFormatter add(MessageFormatter a,
                   MessageFormatter b)

Adds every parameter in both message formatters. Note that a and b must be non-null and have the same player source.

Parameters:

a - - first message formatter to add.

b - - second message formatter to add.

Returns:

The resulting message formatter.

add

public MessageFormatter add(MessageFormatter other)

Adds every parameter in both message formatters, creating a new message formatter with the results.

Parameters:

other - - message formatter to add.

Returns:

The resulting message formatter.

createView

public MessageFormatter createView(org.bukkit.entity.Player player,
                          java.util.Collection<ResourceHolder> result)

createView

public MessageFormatter createView(org.bukkit.entity.Player player,
                          java.util.Collection<ResourceHolder> result,
                          java.lang.Integer count)

createView

public MessageFormatter createView(java.util.Collection<ResourceHolder> result)