Class Property<T,K>

java.lang.Object

com.codename1.properties.PropertyBase<T,K>

com.codename1.properties.Property<T,K>

Direct Known Subclasses:

BooleanProperty, NumericProperty

public class Property<T,K>
extends PropertyBase<T,K>

Base class for a property, it can store a generic value of any type and broadcast change events to external listeners

Constructor Summary

Constructors

Constructor	Description
Property(String name)	Constructs a property with null value
Property(String name, Class genericType)	Constructs a property with null value
Property(String name, Class genericType, T value)	Constructs a property with the given name and value
Property(String name, T value)	Constructs a property with the given name and value

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Compares this property to another property
T	get()	Gets the property value
int	hashCode()	Returns the internal hashcode or 0 for null property
K	set(T value)	Sets the property value and potentially fires a change event
String	toString()	Default toString that provides easier debug information

Methods inherited from class PropertyBase

addChangeListener, bindGlobalGetListener, bindGlobalSetListener, firePropertyChanged, getClientProperty, getGenericType, getLabel, getName, putClientProperty, removeChangeListener, setLabel, stopListening, validateCollectionType

Modifier and Type	Method	Description
void	addChangeListener(PropertyChangeListener<T,K> pl)	Fires a notification that a property value changed to the given listener
static void	bindGlobalGetListener(PropertyChangeListener listener)	Binds an event callback for get calls and property reads
static void	bindGlobalSetListener(PropertyChangeListener listener)	Binds an event callback for set calls and property mutation
protected void	firePropertyChanged()	Delivers the property change event to listeners if applicable
Object	getClientProperty(String key)	Returns the client property set to this property name
Class	getGenericType()	Returns the generic type of this property if it is known or null
String	getLabel()	The label of the property defaults to its name but can be changed to anything
String	getName()	The property name is immutable and can't be changed after creation it should match the parent field name by convention
void	putClientProperty(String key, Object o)	Places a property that will apply statically to all instances of this property
void	removeChangeListener(PropertyChangeListener<T,K> pl)	Removes the property change listener from the list of listeners
void	setLabel(String label)	The label of the property defaults to its name but can be changed to anything, it can be used when binding a property to UI elements
void	stopListening()	This method will work when invoked from a propertyChanged callback and should be similar to removePropertyChangeListener(this).
protected final void	validateCollectionType(Class elementType)	Validates that the collection type is valid and throws an exception otherwise

Methods inherited from class Object

clone, getClass, notify, notifyAll, wait, wait, wait

Modifier and Type	Method	Description
protected Object	clone()
final Class	getClass()	Returns the runtime class of an object.
final void	notify()	Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll()	Wakes up all threads that are waiting on this object's monitor.
final void	wait()	Causes current thread to wait until another thread invokes the method or the method for this object.
final void	wait(long timeout)	Causes current thread to wait until either another thread invokes the method or the method for this object, or a specified amount of time has elapsed.
final void	wait(long timeout, int nanos)	Causes current thread to wait until another thread invokes the method or the method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.

Constructor Details

Property

public Property(String name,
 T value)

Constructs a property with the given name and value

Parameters

• name: the name of the property

• value: the default value for the property

Property

public Property(String name,
 Class genericType,
 T value)

Constructs a property with the given name and value

Parameters

• name: the name of the property

• genericType: the type of the property

• value: the default value for the property

Property

public Property(String name)

Constructs a property with null value

Parameters

• name: the name of the property

Property

public Property(String name,
 Class genericType)

Constructs a property with null value

Parameters

• genericType: the type of the property

• name: the name of the property

Method Details

get

public T get()

Gets the property value

Returns

the property value

set

public K set(T value)

Sets the property value and potentially fires a change event

Parameters

• value: the new value

equals

public boolean equals(Object obj)

Compares this property to another property

Parameters

• obj: the other property

Returns

true if they are equal in name and value

Overrides:

equals in class PropertyBase<T,K>

hashCode

public int hashCode()

Returns the internal hashcode or 0 for null property

Returns

the hashcode value

Overrides:

hashCode in class PropertyBase<T,K>

toString

public String toString()

Description copied from class: PropertyBase

Default toString that provides easier debug information

Returns

a formatted representation of the property for debugging

Overrides:

toString in class PropertyBase<T,K>