de.gurkenlabs.litiengine.environment.tilemap.ICustomPropertyProvider Maven / Gradle / Ivy
package de.gurkenlabs.litiengine.environment.tilemap;
import java.awt.Color;
import java.net.URL;
import java.util.List;
import java.util.Map;
import java.util.NoSuchElementException;
/**
* The Interface ICustomPropertyProvider is providing methods to get and set custom properties.
*/
public interface ICustomPropertyProvider {
/**
* Checks if a custom property with the given name is present.
*
* @param propertyName
* the name of the custom property
* @return true if a custom property with the given name is present. False otherwise.
*/
boolean hasCustomProperty(String propertyName);
ICustomProperty getProperty(String propertyName);
void setValue(String propertyName, ICustomProperty value);
void removeProperty(String propertyName);
/**
* Gets the string value of the custom property with the provided name.
*
* @param propertyName
* the name of the custom property
* @return the string value of the custom property
* @throws NoSuchElementException
* if the custom property does not exist
*/
String getStringValue(String propertyName);
/**
* 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.
*
* @param propertyName
* the name of the custom property
* @param defaultValue
* the fallback value in case the property value is null.
* @return the string value of the custom property, if present. Otherwise, the provided default value is returned.
*/
String getStringValue(String propertyName, String defaultValue);
/**
* Gets a list of strings stored in a single comma-separated property.
*
* @param propertyName
* the name of the custom property
* @param defaultValue
* the fallback value in case the property value is null.
* @return the list of comma-separated strings in the custom property, if present. Otherwise, the provided default value
* is returned.
*/
List getCommaSeparatedStringValues(String propertyName, String defaultValue);
/**
* Gets the char value of the custom property with the provided name.
*
* @param propertyName
* the name of the custom property
* @return the char value of the custom property
* @throws NoSuchElementException
* if the custom property does not exist
* @throws NumberFormatException
* if the custom property is not a char or is not in range for a {@code char}
*/
char getCharValue(String propertyName);
/**
* Gets the char value of the custom property with the provided name. If the value is null, the provided default value is
* used as a fallback.
*
* @param propertyName
* the name of the custom property
* @param defaultValue
* the fallback value in case the property value is null.
* @return the char value of the custom property, if present. Otherwise, the provided default value is returned.
*/
char getCharValue(String propertyName, char defaultValue);
/**
* Gets the int value of the custom property with the provided name.
*
* @param propertyName
* the name of the custom property
* @return the int value of the custom property
* @throws NoSuchElementException
* if the custom property does not exist
* @throws NumberFormatException
* if the custom property is not an integer or is not in range for an {@code int}
*/
int getIntValue(String propertyName);
/**
* 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.
*
* @param propertyName
* the name of the custom property
* @param defaultValue
* the fallback value in case the property value is null.
* @return the int value of the custom property, if present. Otherwise, the provided default value is returned.
*/
int getIntValue(String propertyName, int defaultValue);
/**
* Gets the long value of the custom property with the provided name.
*
* @param propertyName
* the name of the custom property
* @return the long value of the custom property
* @throws NoSuchElementException
* if the custom property does not exist
* @throws NumberFormatException
* if the custom property is not an integer or is not in range for a {@code long}
*/
long getLongValue(String propertyName);
/**
* 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.
*
* @param propertyName
* the name of the custom property
* @param defaultValue
* the fallback value in case the property value is null.
* @return the long value of the custom property, if present. Otherwise, the provided default value is returned.
*/
long getLongValue(String propertyName, long defaultValue);
/**
* Gets the short value of the custom property with the provided name.
*
* @param propertyName
* the name of the custom property
* @return the short value of the custom property
* @throws NoSuchElementException
* if the custom property does not exist
* @throws NumberFormatException
* if the custom property is not an integer or is out of range for a {@code short}
*/
short getShortValue(String propertyName);
/**
* 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.
*
* @param propertyName
* the name of the custom property
* @param defaultValue
* the fallback value in case the property value is null.
* @return the short value of the custom property, if present. Otherwise, the provided default value is returned.
*/
short getShortValue(String propertyName, short defaultValue);
/**
* Gets the byte value of the custom property with the provided name.
*
* @param propertyName
* the name of the custom property
* @return the byte value of the custom property
* @throws NoSuchElementException
* if the custom property does not exist
* @throws NumberFormatException
* if the custom property is not an integer or is out of range for a {@code byte}
*/
byte getByteValue(String propertyName);
/**
* 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.
*
* @param propertyName
* the name of the custom property
* @param defaultValue
* the fallback value in case the property value is null.
* @return the byte value of the custom property, if present. Otherwise, the provided default value is returned.
*/
byte getByteValue(String propertyName, byte defaultValue);
/**
* Gets the boolean value of the custom property with the provided name.
*
* @param propertyName
* the name of the custom property
* @return the boolean value of the custom property
* @throws NoSuchElementException
* if the custom property does not exist
* @throws NumberFormatException
* if the custom property is not a {@code boolean} value
*/
boolean getBoolValue(String propertyName);
/**
* 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.
*
* @param propertyName
* the name of the custom property
* @param defaultValue
* the fallback value in case the property value is null.
* @return the boolean value of the custom property, if present. Otherwise, the provided default value is returned.
*/
boolean getBoolValue(String propertyName, boolean defaultValue);
/**
* Gets the float value of the custom property with the provided name.
*
* @param propertyName
* the name of the custom property
* @return the float value of the custom property
* @throws NoSuchElementException
* if the custom property does not exist
* @throws NumberFormatException
* if the custom property is not a number
*/
float getFloatValue(String propertyName);
/**
* 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.
*
* @param propertyName
* the name of the custom property
* @param defaultValue
* the fallback value in case the property value is null.
* @return the float value of the custom property, if present. Otherwise, the provided default value is returned.
*/
float getFloatValue(String propertyName, float defaultValue);
/**
* Gets the double value of the custom property with the provided name.
*
* @param propertyName
* the name of the custom property
* @return the double value of the custom property
* @throws NoSuchElementException
* if the custom property does not exist
* @throws NumberFormatException
* if the custom property is not a number
*/
double getDoubleValue(String propertyName);
/**
* 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.
*
* @param propertyName
* the name of the custom property
* @param defaultValue
* the fallback value in case the property value is null.
* @return the double value of the custom property, if present. Otherwise, the provided default value is returned.
*/
double getDoubleValue(String propertyName, double defaultValue);
/**
* Gets the color value of the custom property with the provided name.
*
* @param propertyName
* the name of the custom property
* @return the color value of the custom property
* @throws NoSuchElementException
* if the custom property does not exist
*/
Color getColorValue(String propertyName);
/**
* 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.
*
* @param propertyName
* the name of the custom property
* @param defaultValue
* the fallback value in case the property value is null.
* @return the color value of the custom property, if present. Otherwise, the provided default value is returned.
*/
Color getColorValue(String propertyName, Color defaultValue);
/**
* Gets the enum value of the custom property with the provided name.
*
* @param propertyName
* the name of the custom property
* @param enumType
* a {@code Class} object for {@code }
* @param
* the enum type to use
* @return the enum value of the custom property
* @throws NoSuchElementException
* if the custom property does not exist
*/
> T getEnumValue(String propertyName, Class enumType);
/**
* 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.
*
* @param propertyName
* the name of the custom property
* @param defaultValue
* the fallback value in case the property value is null.
* @param enumType
* a {@code Class} object for {@code }
* @param
* the enum type to use
* @return the enum value of the custom property, if present. Otherwise, the provided default value is returned.
*/
> T getEnumValue(String propertyName, Class enumType, T defaultValue);
/**
* Gets the file value of the custom property with the provided name. If the property is not a file, {@code null} is
* returned instead.
*
* @param propertyName
* the name of the custom property
* @return the file value of the custom property, if present.
*/
URL getFileValue(String propertyName);
/**
* Gets the file value of the custom property with the provided name. If the value is null or the property is not a
* file, the provided default value is used as a fallback.
*
* @param propertyName
* the name of the custom property
* @param defaultValue
* the fallback value in case the property value is null.
* @return the file value of the custom property, if present. Otherwise, the provided default value is returned.
*/
URL getFileValue(String propertyName, URL defaultValue);
int getMapObjectId(String propertyName);
/**
* Sets the value for the custom property with the given name to the given file.
*
* @param propertyName
* the name of the custom property
* @param value
* the new value
*/
void setValue(String propertyName, URL value);
/**
* Sets the value for the custom property with the given name to the given string.
*
* @param propertyName
* the name of the custom property
* @param value
* the new value
*/
void setValue(String propertyName, String value);
/**
* Sets the value for the custom property with the given name to the given boolean.
*
* @param propertyName
* the name of the custom property
* @param value
* the new value
*/
void setValue(String propertyName, boolean value);
/**
* Sets the value for the custom property with the given name to the given byte.
*
* @param propertyName
* the name of the custom property
* @param value
* the new value
*/
void setValue(String propertyName, byte value);
/**
* Sets the value for the custom property with the given name to the given short.
*
* @param propertyName
* the name of the custom property
* @param value
* the new value
*/
void setValue(String propertyName, short value);
/**
* Sets the value for the custom property with the given name to the given char.
*
* @param propertyName
* the name of the custom property
* @param value
* the new value
*/
void setValue(String propertyName, char value);
/**
* Sets the value for the custom property with the given name to the given int.
*
* @param propertyName
* the name of the custom property
* @param value
* the new value
*/
void setValue(String propertyName, int value);
/**
* Sets the value for the custom property with the given name to the given long.
*
* @param propertyName
* the name of the custom property
* @param value
* the new value
*/
void setValue(String propertyName, long value);
/**
* Sets the value for the custom property with the given name to the given float.
*
* @param propertyName
* the name of the custom property
* @param value
* the new value
*/
void setValue(String propertyName, float value);
/**
* Sets the value for the custom property with the given name to the given double.
*
* @param propertyName
* the name of the custom property
* @param value
* the new value
*/
void setValue(String propertyName, double value);
/**
* Sets the value for the custom property with the given name to the given color.
*
* @param propertyName
* the name of the custom property
* @param value
* the new value
*/
void setValue(String propertyName, Color value);
/**
* Sets the value for the custom property with the given name to the given enum.
*
* @param propertyName
* the name of the custom property
* @param value
* the new value
*/
void setValue(String propertyName, Enum value);
/**
* Sets the value for the custom property with the ID of the given map object.
*
* @param propertyName
* the name of the custom property
* @param value
* the new value
*/
void setValue(String propertyName, IMapObject value);
/**
* Returns a {@code Map} view of the custom properties for this {@code ICustomPropertyProvider}.
*
* @return a {@code Map} view of the custom properties for this {@code ICustomPropertyProvider}
*/
Map getProperties();
/**
* Sets all 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.
*
* @param props
* the new list of properties
*/
void setProperties(Map props);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy