net.sf.gridarta.model.baseobject

Class GameObjectText

java.lang.Object

net.sf.gridarta.model.baseobject.GameObjectText

All Implemented Interfaces:

java.io.Serializable

public class GameObjectText
extends java.lang.Object
implements java.io.Serializable

A set of key/value attributes.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GameObjectText() Creates a new instance.
GameObjectText(GameObjectText gameObjectText) Creates a new instance as a copy of another instance.

Method Summary

Modifier and Type	Method and Description
boolean	addObjectText(java.lang.String line, AbstractBaseObject<?,?,?,?> baseObject) Appends a line to the object text.
boolean	equals(java.lang.Object obj)
java.util.Collection<java.lang.String>	getAttributeKeys() Returns all attribute keys of this object.
java.lang.String	getAttributeValue(java.lang.String attributeName) Returns an attribute value by attribute name.
java.lang.String	getObjectText() Returns the object text.
int	hashCode()
boolean	hasObjectText() Returns whether an object text is set.
boolean	removeAttribute(java.lang.String attributeName, AbstractBaseObject<?,?,?,?> baseObject) Removes an attribute.
boolean	setAttributeValue(java.lang.String attributeName, boolean sameAsInArchetype, java.lang.String value, AbstractBaseObject<?,?,?,?> baseObject) Updates an attribute's value.
boolean	setObjectText(java.lang.String objectText, AbstractBaseObject<?,?,?,?> baseObject) Sets the object text.

Methods inherited from class java.lang.Object

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

Constructor Detail

GameObjectText

public GameObjectText()

Creates a new instance.

GameObjectText

public GameObjectText(@NotNull
                      GameObjectText gameObjectText)

Creates a new instance as a copy of another instance.

Parameters:

gameObjectText - the other instance

Method Detail

getAttributeValue

@Nullable
public java.lang.String getAttributeValue(@NotNull
                                                    java.lang.String attributeName)

Returns an attribute value by attribute name.

Parameters:

attributeName - the attribute name

Returns:

the attribute value or null

getObjectText

@NotNull
public java.lang.String getObjectText()

Returns the object text.

Returns:

the object text

hasObjectText

public boolean hasObjectText()

Returns whether an object text is set.

Returns:

whether an object text is set

addObjectText

public boolean addObjectText(@NotNull
                             java.lang.String line,
                             @NotNull
                             AbstractBaseObject<?,?,?,?> baseObject)

Appends a line to the object text.

Parameters:

line - the line to append, may contain '\n' for appending multiple lines

baseObject - the game object to notify of changes

Returns:

whether the object text was changed

setObjectText

public boolean setObjectText(@NotNull
                             java.lang.String objectText,
                             @NotNull
                             AbstractBaseObject<?,?,?,?> baseObject)

Sets the object text.

Parameters:

objectText - the object text to set

baseObject - the game object to notify of changes

Returns:

whether the object text was changed

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(@Nullable
                      java.lang.Object obj)

Overrides:

equals in class java.lang.Object

removeAttribute

public boolean removeAttribute(@NotNull
                               java.lang.String attributeName,
                               @NotNull
                               AbstractBaseObject<?,?,?,?> baseObject)

Removes an attribute.

Parameters:

attributeName - the attribute name

baseObject - the game object to notify of changes

Returns:

whether the object text has changed

setAttributeValue

public boolean setAttributeValue(@NotNull
                                 java.lang.String attributeName,
                                 boolean sameAsInArchetype,
                                 @NotNull
                                 java.lang.String value,
                                 @NotNull
                                 AbstractBaseObject<?,?,?,?> baseObject)

Updates an attribute's value.

Parameters:

attributeName - the attribute name

sameAsInArchetype - whether the new value is the same as in the archetype

value - the new value

baseObject - the game object to notify of changes

Returns:

whether the object text has changed

getAttributeKeys

@NotNull
public java.util.Collection<java.lang.String> getAttributeKeys()

Returns all attribute keys of this object.

Returns:

the attribute keys