org.mudcraft.bukkit.socials
Class Social

java.lang.Object
  extended by org.mudcraft.bukkit.socials.Social
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class Social
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

Represents a pre-configured emote a player can perform.

Author:
Geoffrey Davis
See Also:
Serialized Form

Constructor Summary
Social()
          Constructs a new Social instance.
Social(Social other)
          Constructs a new Social instance.
 
Method Summary
 java.lang.Object clone()
          Creates a copy of this object.
 boolean equals(java.lang.Object o)
          Gets whether this object is equal to another object.
 java.lang.String getActorMessage()
          Gets the message shown when the actor performing the social is also the target of the social.
 java.util.Date getCreated()
          Gets the creation time stamp.
 java.lang.String getCreatedBy()
          Gets the name of the player who created the social.
 java.lang.Integer getId()
          Gets the record identity.
 java.util.Date getModified()
          Gets the modification time stamp.
 java.lang.String getModifiedBy()
          Gets the name of the player who modified the social.
 java.lang.String getName()
          Gets the social's name.
 java.lang.String getNoArgumentMessage()
          Gets the message shown when the actor does not specify a target.
 java.lang.String getTargetMessage()
          Gets the message shown when the actor specifies a target.
 int hashCode()
          Calculates a hashcode for this object.
 void perform(Socials plugin, org.bukkit.entity.Player actor, java.lang.String[] split)
          Causes the Player specified by actor to perform this social.
 void setActorMessage(java.lang.String actorMessage)
          Sets the message shown when the actor performing the social is also the target of the social.
 void setCreated(java.util.Date created)
          Sets the creation time stamp.
 void setCreatedBy(java.lang.String createdBy)
          Sets the name of the player that created the social.
 void setId(java.lang.Integer id)
          Sets the record identity.
 void setModified(java.util.Date modified)
          Sets the modification time stamp.
 void setModifiedBy(java.lang.String modifiedBy)
          Sets the name of the player that modified the social.
 void setName(java.lang.String name)
          Sets the social's name.
 void setNoArgumentMessage(java.lang.String noArgumentMessage)
          Sets the message shown when the actor does not specify a target.
 void setTargetMessage(java.lang.String targetMessage)
          Sets the message shown when the actor specifies a target.
 java.lang.String toString()
          Returns a string representation of the object.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Social

public Social()
Constructs a new Social instance.


Social

public Social(Social other)
Constructs a new Social instance.

Parameters:
other - the Social whose state is to be copied
Method Detail

clone

public java.lang.Object clone()
Creates a copy of this object.

Overrides:
clone in class java.lang.Object
Returns:
a copy of this object
See Also:
Cloneable, Object.clone()

equals

public boolean equals(java.lang.Object o)
Gets whether this object is equal to another object.

Overrides:
equals in class java.lang.Object
Parameters:
o - the object to which this object is to be compared
Returns:
true if the specified object is equivalent
See Also:
Object.equals(Object)

getActorMessage

public java.lang.String getActorMessage()
Gets the message shown when the actor performing the social is also the target of the social.

Returns:
the social's actor message
See Also:
setActorMessage(String)

getCreated

public java.util.Date getCreated()
Gets the creation time stamp.

Returns:
the creation time stamp
See Also:
setCreated(Date)

getCreatedBy

public java.lang.String getCreatedBy()
Gets the name of the player who created the social.

Returns:
the name of the player who created the social
See Also:
setCreatedBy(String)

getId

public java.lang.Integer getId()
Gets the record identity.

Returns:
the record identity
See Also:
setId(Integer)

getModified

public java.util.Date getModified()
Gets the modification time stamp.

Returns:
the modification time stamp
See Also:
setModified(Date)

getModifiedBy

public java.lang.String getModifiedBy()
Gets the name of the player who modified the social.

Returns:
the name of the player who modified the social
See Also:
setModifiedBy(String)

getName

public java.lang.String getName()
Gets the social's name.

Returns:
the social's name
See Also:
setName(String)

getNoArgumentMessage

public java.lang.String getNoArgumentMessage()
Gets the message shown when the actor does not specify a target.

Returns:
the social's no argument message
See Also:
setNoArgumentMessage(String)

getTargetMessage

public java.lang.String getTargetMessage()
Gets the message shown when the actor specifies a target.

Returns:
the social's target message
See Also:
setTargetMessage(String)

hashCode

public int hashCode()
Calculates a hashcode for this object.

Overrides:
hashCode in class java.lang.Object
Returns:
a hashcode for this object
See Also:
Object.hashCode()

perform

public void perform(Socials plugin,
                    org.bukkit.entity.Player actor,
                    java.lang.String[] split)
Causes the Player specified by actor to perform this social.

Parameters:
plugin - the Socials object
actor - the Player performing the social
split - an array containing any arguments specified by the player at the name line

setActorMessage

public void setActorMessage(java.lang.String actorMessage)
Sets the message shown when the actor performing the social is also the target of the social.

Parameters:
actorMessage - the social's actor message
See Also:
getActorMessage()

setCreated

public void setCreated(java.util.Date created)
Sets the creation time stamp.

Parameters:
created - the creation time stamp
See Also:
getCreated()

setCreatedBy

public void setCreatedBy(java.lang.String createdBy)
Sets the name of the player that created the social.

Parameters:
createdBy - the name of the player that created the social
See Also:
getCreatedBy()

setId

public void setId(java.lang.Integer id)
Sets the record identity.

Parameters:
id - the record identity
See Also:
getId()

setModified

public void setModified(java.util.Date modified)
Sets the modification time stamp.

Parameters:
modified - the modification time stamp
See Also:
getModified()

setModifiedBy

public void setModifiedBy(java.lang.String modifiedBy)
Sets the name of the player that modified the social.

Parameters:
modifiedBy - the name of the player that modified the social
See Also:
getModifiedBy()

setName

public void setName(java.lang.String name)
Sets the social's name.

Parameters:
name - the social's name
See Also:
getName()

setNoArgumentMessage

public void setNoArgumentMessage(java.lang.String noArgumentMessage)
Sets the message shown when the actor does not specify a target.

Parameters:
noArgumentMessage - the social's no argument message
See Also:
getNoArgumentMessage()

setTargetMessage

public void setTargetMessage(java.lang.String targetMessage)
Sets the message shown when the actor specifies a target.

Parameters:
targetMessage - the social's target message
See Also:
getTargetMessage()

toString

public java.lang.String toString()
Returns a string representation of the object.

Overrides:
toString in class java.lang.Object
Returns:
a string representation of the object
See Also:
Object.toString()