de.gurkenlabs.litiengine.environment.tilemap.xml

Class CustomPropertyProvider

java.lang.Object

de.gurkenlabs.litiengine.environment.tilemap.xml.CustomPropertyProvider

All Implemented Interfaces:

ICustomPropertyProvider, java.io.Serializable

Direct Known Subclasses:

GameInfo, Layer, Map, MapImage, MapObject, Terrain, Tile, TileOffset, Tileset

public class CustomPropertyProvider
extends java.lang.Object
implements ICustomPropertyProvider, java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CustomPropertyProvider()
CustomPropertyProvider(CustomPropertyProvider propertyProviderToBeCopied) Copy Constructor for copying instances of CustomPropertyProviders.

Method Summary

Modifier and Type	Method and Description
boolean	getBoolValue(java.lang.String name) Gets the boolean value of the custom property with the provided name.
boolean	getBoolValue(java.lang.String name, boolean defaultValue) Gets the boolean value of the custom property with the provided name.
byte	getByteValue(java.lang.String name) Gets the byte value of the custom property with the provided name.
byte	getByteValue(java.lang.String name, byte defaultValue) Gets the byte value of the custom property with the provided name.
java.awt.Color	getColorValue(java.lang.String name) Gets the color value of the custom property with the provided name.
java.awt.Color	getColorValue(java.lang.String name, java.awt.Color defaultValue) Gets the color value of the custom property with the provided name.
double	getDoubleValue(java.lang.String name) Gets the double value of the custom property with the provided name.
double	getDoubleValue(java.lang.String name, double defaultValue) Gets the double value of the custom property with the provided name.
<T extends java.lang.Enum<T>> T	getEnumValue(java.lang.String name, java.lang.Class<T> enumType) Gets the enum value of the custom property with the provided name.
<T extends java.lang.Enum<T>> T	getEnumValue(java.lang.String name, java.lang.Class<T> enumType, T defaultValue) Gets the enum value of the custom property with the provided name.
float	getFloatValue(java.lang.String name) Gets the float value of the custom property with the provided name.
float	getFloatValue(java.lang.String name, float defaultValue) Gets the float value of the custom property with the provided name.
int	getIntValue(java.lang.String name) Gets the int value of the custom property with the provided name.
int	getIntValue(java.lang.String name, int defaultValue) Gets the int value of the custom property with the provided name.
long	getLongValue(java.lang.String name) Gets the long value of the custom property with the provided name.
long	getLongValue(java.lang.String name, long defaultValue) Gets the long value of the custom property with the provided name.
java.util.List<Property>	getProperties() Enumerates the custom properties for this object.
short	getShortValue(java.lang.String name) Gets the short value of the custom property with the provided name.
short	getShortValue(java.lang.String name, short defaultValue) Gets the short value of the custom property with the provided name.
java.lang.String	getStringValue(java.lang.String name) Gets the string value of the custom property with the provided name.
java.lang.String	getStringValue(java.lang.String name, java.lang.String defaultValue) Gets the string value of the custom property with the provided name.
boolean	hasCustomProperty(java.lang.String name) Checks if a custom property with the given name is present.
void	setProperties(java.util.List<Property> props) Sets all of the custom properties on this object to the provided values.
void	setValue(java.lang.String name, boolean value) Sets the value for the custom property with the given name to the given boolean.
void	setValue(java.lang.String name, byte value) Sets the value for the custom property with the given name to the given byte.
void	setValue(java.lang.String name, java.awt.Color value) Sets the value for the custom property with the given name to the given color.
void	setValue(java.lang.String name, double value) Sets the value for the custom property with the given name to the given double.
void	setValue(java.lang.String name, java.lang.Enum<?> value) Sets the value for the custom property with the given name to the given enum.
void	setValue(java.lang.String name, float value) Sets the value for the custom property with the given name to the given float.
void	setValue(java.lang.String name, int value) Sets the value for the custom property with the given name to the given int.
void	setValue(java.lang.String name, long value) Sets the value for the custom property with the given name to the given long.
void	setValue(java.lang.String name, short value) Sets the value for the custom property with the given name to the given short.
void	setValue(java.lang.String name, java.lang.String value) Sets the value for the custom property with the given name to the given string.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomPropertyProvider

public CustomPropertyProvider()

CustomPropertyProvider

public CustomPropertyProvider(CustomPropertyProvider propertyProviderToBeCopied)

Copy Constructor for copying instances of CustomPropertyProviders.

Parameters:

propertyProviderToBeCopied - the PropertyProvider we want to copy

Method Detail

hasCustomProperty

public boolean hasCustomProperty(java.lang.String name)

Description copied from interface: ICustomPropertyProvider

Checks if a custom property with the given name is present.

Specified by:

hasCustomProperty in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

Returns:

true if a custom property with the given name is present. False otherwise.

getStringValue

public java.lang.String getStringValue(java.lang.String name)

Description copied from interface: ICustomPropertyProvider

Gets the string value of the custom property with the provided name.

Specified by:

getStringValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

Returns:

the string value of the custom property

getStringValue

public java.lang.String getStringValue(java.lang.String name,
                                       java.lang.String defaultValue)

Description copied from interface: ICustomPropertyProvider

Gets the string value of the custom property with the provided name. If the value is null, the provided default value is used as a fallback.

Specified by:

getStringValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

defaultValue - the fallback value in case the property value is null.

Returns:

the string value of the custom property, if present. Otherwise, the provided default value is returned.

getProperties

public java.util.List<Property> getProperties()

Description copied from interface: ICustomPropertyProvider

Enumerates the custom properties for this object.

Specified by:

getProperties in interface ICustomPropertyProvider

Returns:

a complete list of custom properties for this ICustomPropertyProvider

setProperties

public void setProperties(java.util.List<Property> props)

Description copied from interface: ICustomPropertyProvider

Sets all of the custom properties on this object to the provided values. Properties are added when they only exist in the provided properties, and deleted when they only exist in the current properties.

Specified by:

setProperties in interface ICustomPropertyProvider

Parameters:

props - the new list of properties

getIntValue

public int getIntValue(java.lang.String name)

Description copied from interface: ICustomPropertyProvider

Gets the int value of the custom property with the provided name.

Specified by:

getIntValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

Returns:

the int value of the custom property

getIntValue

public int getIntValue(java.lang.String name,
                       int defaultValue)

Description copied from interface: ICustomPropertyProvider

Gets the int value of the custom property with the provided name. If the value is null, the provided default value is used as a fallback.

Specified by:

getIntValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

defaultValue - the fallback value in case the property value is null.

Returns:

the int value of the custom property, if present. Otherwise, the provided default value is returned.

getShortValue

public short getShortValue(java.lang.String name)

Description copied from interface: ICustomPropertyProvider

Gets the short value of the custom property with the provided name.

Specified by:

getShortValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

Returns:

the short value of the custom property

getShortValue

public short getShortValue(java.lang.String name,
                           short defaultValue)

Description copied from interface: ICustomPropertyProvider

Gets the short value of the custom property with the provided name. If the value is null, the provided default value is used as a fallback.

Specified by:

getShortValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

defaultValue - the fallback value in case the property value is null.

Returns:

the short value of the custom property, if present. Otherwise, the provided default value is returned.

getByteValue

public byte getByteValue(java.lang.String name)

Description copied from interface: ICustomPropertyProvider

Gets the byte value of the custom property with the provided name.

Specified by:

getByteValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

Returns:

the byte value of the custom property

getByteValue

public byte getByteValue(java.lang.String name,
                         byte defaultValue)

Description copied from interface: ICustomPropertyProvider

Gets the byte value of the custom property with the provided name. If the value is null, the provided default value is used as a fallback.

Specified by:

getByteValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

defaultValue - the fallback value in case the property value is null.

Returns:

the byte value of the custom property, if present. Otherwise, the provided default value is returned.

getLongValue

public long getLongValue(java.lang.String name)

Description copied from interface: ICustomPropertyProvider

Gets the long value of the custom property with the provided name.

Specified by:

getLongValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

Returns:

the long value of the custom property

getLongValue

public long getLongValue(java.lang.String name,
                         long defaultValue)

Description copied from interface: ICustomPropertyProvider

Gets the long value of the custom property with the provided name. If the value is null, the provided default value is used as a fallback.

Specified by:

getLongValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

defaultValue - the fallback value in case the property value is null.

Returns:

the long value of the custom property, if present. Otherwise, the provided default value is returned.

getBoolValue

public boolean getBoolValue(java.lang.String name)

Description copied from interface: ICustomPropertyProvider

Gets the boolean value of the custom property with the provided name.

Specified by:

getBoolValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

Returns:

the boolean value of the custom property

getBoolValue

public boolean getBoolValue(java.lang.String name,
                            boolean defaultValue)

Description copied from interface: ICustomPropertyProvider

Gets the boolean value of the custom property with the provided name. If the value is null, the provided default value is used as a fallback.

Specified by:

getBoolValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

defaultValue - the fallback value in case the property value is null.

Returns:

the boolean value of the custom property, if present. Otherwise, the provided default value is returned.

getFloatValue

public float getFloatValue(java.lang.String name)

Description copied from interface: ICustomPropertyProvider

Gets the float value of the custom property with the provided name.

Specified by:

getFloatValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

Returns:

the float value of the custom property

getFloatValue

public float getFloatValue(java.lang.String name,
                           float defaultValue)

Description copied from interface: ICustomPropertyProvider

Gets the float value of the custom property with the provided name. If the value is null, the provided default value is used as a fallback.

Specified by:

getFloatValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

defaultValue - the fallback value in case the property value is null.

Returns:

the float value of the custom property, if present. Otherwise, the provided default value is returned.

getDoubleValue

public double getDoubleValue(java.lang.String name)

Description copied from interface: ICustomPropertyProvider

Gets the double value of the custom property with the provided name.

Specified by:

getDoubleValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

Returns:

the double value of the custom property

getDoubleValue

public double getDoubleValue(java.lang.String name,
                             double defaultValue)

Description copied from interface: ICustomPropertyProvider

Gets the double value of the custom property with the provided name. If the value is null, the provided default value is used as a fallback.

Specified by:

getDoubleValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

defaultValue - the fallback value in case the property value is null.

Returns:

the double value of the custom property, if present. Otherwise, the provided default value is returned.

getColorValue

public java.awt.Color getColorValue(java.lang.String name)

Description copied from interface: ICustomPropertyProvider

Gets the color value of the custom property with the provided name.

Specified by:

getColorValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

Returns:

the color value of the custom property

getColorValue

public java.awt.Color getColorValue(java.lang.String name,
                                    java.awt.Color defaultValue)

Description copied from interface: ICustomPropertyProvider

Gets the color value of the custom property with the provided name. If the value is null, the provided default value is used as a fallback.

Specified by:

getColorValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

defaultValue - the fallback value in case the property value is null.

Returns:

the color value of the custom property, if present. Otherwise, the provided default value is returned.

getEnumValue

public <T extends java.lang.Enum<T>> T getEnumValue(java.lang.String name,
                                                    java.lang.Class<T> enumType)

Description copied from interface: ICustomPropertyProvider

Gets the enum value of the custom property with the provided name.

Specified by:

getEnumValue in interface ICustomPropertyProvider

Type Parameters:

T - the enum type to use

Parameters:

name - the name of the custom property

enumType - a Class object for <T>

Returns:

the enum value of the custom property

getEnumValue

public <T extends java.lang.Enum<T>> T getEnumValue(java.lang.String name,
                                                    java.lang.Class<T> enumType,
                                                    T defaultValue)

Description copied from interface: ICustomPropertyProvider

Gets the enum value of the custom property with the provided name. If the value is null, the provided default value is used as a fallback.

Specified by:

getEnumValue in interface ICustomPropertyProvider

Type Parameters:

T - the enum type to use

Parameters:

name - the name of the custom property

enumType - a Class object for <T>

defaultValue - the fallback value in case the property value is null.

Returns:

the enum value of the custom property, if present. Otherwise, the provided default value is returned.

setValue

public void setValue(java.lang.String name,
                     java.lang.String value)

Description copied from interface: ICustomPropertyProvider

Sets the value for the custom property with the given name to the given string.

Specified by:

setValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

value - the new value

setValue

public void setValue(java.lang.String name,
                     boolean value)

Description copied from interface: ICustomPropertyProvider

Sets the value for the custom property with the given name to the given boolean.

Specified by:

setValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

value - the new value

setValue

public void setValue(java.lang.String name,
                     byte value)

Description copied from interface: ICustomPropertyProvider

Sets the value for the custom property with the given name to the given byte.

Specified by:

setValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

value - the new value

setValue

public void setValue(java.lang.String name,
                     short value)

Description copied from interface: ICustomPropertyProvider

Sets the value for the custom property with the given name to the given short.

Specified by:

setValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

value - the new value

setValue

public void setValue(java.lang.String name,
                     int value)

Description copied from interface: ICustomPropertyProvider

Sets the value for the custom property with the given name to the given int.

Specified by:

setValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

value - the new value

setValue

public void setValue(java.lang.String name,
                     long value)

Description copied from interface: ICustomPropertyProvider

Sets the value for the custom property with the given name to the given long.

Specified by:

setValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

value - the new value

setValue

public void setValue(java.lang.String name,
                     float value)

Description copied from interface: ICustomPropertyProvider

Sets the value for the custom property with the given name to the given float.

Specified by:

setValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

value - the new value

setValue

public void setValue(java.lang.String name,
                     double value)

Description copied from interface: ICustomPropertyProvider

Sets the value for the custom property with the given name to the given double.

Specified by:

setValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

value - the new value

setValue

public void setValue(java.lang.String name,
                     java.awt.Color value)

Description copied from interface: ICustomPropertyProvider

Sets the value for the custom property with the given name to the given color.

Specified by:

setValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

value - the new value

setValue

public void setValue(java.lang.String name,
                     java.lang.Enum<?> value)

Description copied from interface: ICustomPropertyProvider

Sets the value for the custom property with the given name to the given enum.

Specified by:

setValue in interface ICustomPropertyProvider

Parameters:

name - the name of the custom property

value - the new value