libGDX 1.14.2 · com.badlogic.gdx.maps.MapProperties · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private ObjectMap<String, Object>	properties

Access	Constructor and Description
public	MapProperties() Creates an empty properties set

Method Summary

Modifier and Type	Method and Description
public void	clear() Removes all properties
public boolean	containsKey(String property name key) Returns: true if and only if the property exists
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Object	get(String property name key) Returns: the value for that property if it exists, otherwise, null
public <T> T	Returns: the object or null if the object is not in the map get(String the key of the object key, Class<T> the class of the object clazz) Returns the object for the given key, casting it to clazz.
public <T> T	Returns: the object or the defaultValue if the object is not in the map get(String the key of the object key, T the default value defaultValue, Class<T> the class of the object clazz) Returns the object for the given key, casting it to clazz.
public Iterator<String>	getKeys() Returns: iterator for the property names
public Iterator<Object>	getValues() Returns: iterator to properties' values
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	put(String property name key, Object value to be inserted or modified (if it already existed) value)
public void	putAll(MapProperties set of properties to be added properties)
public void	remove(String property name to be removed key)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

properties	back to summary
private ObjectMap<String, Object> properties

MapProperties	back to summary
public MapProperties() Creates an empty properties set

Method Detail

clear	back to summary
public void clear() Removes all properties

containsKey	back to summary
public boolean containsKey(String key) Parameters key:String property name Returns:boolean true if and only if the property exists

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

get	back to summary
public Object get(String key) Parameters key:String property name Returns:Object the value for that property if it exists, otherwise, null

get	back to summary
public <T> T get(String key, Class<T> clazz) Returns the object for the given key, casting it to clazz. Parameters key:String the key of the object clazz:Class<T> the class of the object Returns:T the object or null if the object is not in the map Exceptions ClassCastException: if the object with the given key is not of type clazz

get

back to summary

public <T> T get(String key, Class<T> clazz)

Returns the object for the given key, casting it to clazz.

Parameters

key:String: the key of the object
clazz:Class<T>: the class of the object

Returns:T

the object or null if the object is not in the map

Exceptions

ClassCastException:: if the object with the given key is not of type clazz

get	back to summary
public <T> T get(String key, T defaultValue, Class<T> clazz) Returns the object for the given key, casting it to clazz. Parameters key:String the key of the object defaultValue:T the default value clazz:Class<T> the class of the object Returns:T the object or the defaultValue if the object is not in the map Exceptions ClassCastException: if the object with the given key is not of type clazz

get

back to summary

public <T> T get(String key, T defaultValue, Class<T> clazz)

Returns the object for the given key, casting it to clazz.

Parameters

key:String: the key of the object
defaultValue:T: the default value
clazz:Class<T>: the class of the object

Returns:T

the object or the defaultValue if the object is not in the map

Exceptions

ClassCastException:: if the object with the given key is not of type clazz

getKeys	back to summary
public Iterator<String> getKeys() Returns:Iterator<String> iterator for the property names

getValues	back to summary
public Iterator<Object> getValues() Returns:Iterator<Object> iterator to properties' values

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

put	back to summary
public void put(String key, Object value) Parameters key:String property name value:Object value to be inserted or modified (if it already existed)

putAll	back to summary
public void putAll(MapProperties properties) Parameters properties:MapProperties set of properties to be added

remove	back to summary
public void remove(String key) Parameters key:String property name to be removed

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public Class MapProperties

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail