Property

Class Overview

A property is an abstraction that can be used to represent a mutable value that is held in a host object. The Property's set(Object, Object) or get(Object) methods can be implemented in terms of the private fields of the host object, or via "setter" and "getter" methods or by some other mechanism, as appropriate.

Summary

Public Constructors
? Examples	Property( Class<V> type, String name) A constructor that takes an identifying name and `type` for the property.

Public Constructors

? Examples

Property( Class<V> type, String name)

A constructor that takes an identifying name and type for the property.

Public Methods
? Examples	abstract V	get(T object) Returns the current value that this property represents on the given `object`.
? Examples	String	getName() Returns the name for this property.
? Examples	Class<V>	getType() Returns the type for this property.
? Examples	boolean	isReadOnly() Returns true if the `set(Object, Object)` method does not set the value on the target object (in which case the `set()` method should throw a `NoSuchPropertyException` exception).
? Examples	static <T, V> Property<T, V>	of( Class<T> hostType, Class<V> valueType, String name) This factory method creates and returns a Property given the `class` and `name` parameters, where the `"name"` parameter represents either: a public `getName()` method on the class which takes no arguments, plus an optional public `setName()` method which takes a value of the same type returned by `getName()` a public `isName()` method on the class which takes no arguments, plus an optional public `setName()` method which takes a value of the same type returned by `isName()` a public `name` field on the class If either of the get/is method alternatives is found on the class, but an appropriate `setName()` method is not found, the `Property` will be `readOnly`.
? Examples	void	set(T object, V value) Sets the value on `object` which this property represents.

Public Methods

? Examples

abstract V

get(T object)

Returns the current value that this property represents on the given object.

? Examples

String

getName()

Returns the name for this property.

? Examples

Class<V>

getType()

Returns the type for this property.

? Examples

boolean

isReadOnly()

Returns true if the set(Object, Object) method does not set the value on the target object (in which case the set() method should throw a NoSuchPropertyException exception).

? Examples

static <T, V> Property<T, V>

of( Class<T> hostType, Class<V> valueType, String name)

This factory method creates and returns a Property given the class and name parameters, where the "name" parameter represents either:

a public getName() method on the class which takes no arguments, plus an optional public setName() method which takes a value of the same type returned by getName()
a public isName() method on the class which takes no arguments, plus an optional public setName() method which takes a value of the same type returned by isName()
a public name field on the class

If either of the get/is method alternatives is found on the class, but an appropriate setName() method is not found, the Property will be readOnly.

? Examples

void

set(T object, V value)

Sets the value on object which this property represents.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Methods

public abstract V get (T object)

Added in API level 14

Returns the current value that this property represents on the given object.

public String getName ()

Added in API level 14

Returns the name for this property.

public Class<V> getType ()

Added in API level 14

Returns the type for this property.

public boolean isReadOnly ()

Added in API level 14

Returns true if the set(Object, Object) method does not set the value on the target object (in which case the set() method should throw a NoSuchPropertyException exception). This may happen if the Property wraps functionality that allows querying the underlying value but not setting it. For example, the of(Class, Class, String) factory method may return a Property with name "foo" for an object that has only a getFoo() or isFoo() method, but no matching setFoo() method.

public static Property<T, V> of (Class<T> hostType, Class<V> valueType, String name)

Added in API level 14

This factory method creates and returns a Property given the class and name parameters, where the "name" parameter represents either:

a public getName() method on the class which takes no arguments, plus an optional public setName() method which takes a value of the same type returned by getName()
a public isName() method on the class which takes no arguments, plus an optional public setName() method which takes a value of the same type returned by isName()
a public name field on the class

If either of the get/is method alternatives is found on the class, but an appropriate setName() method is not found, the Property will be readOnly. Calling the set(Object, Object) method on such a property is allowed, but will have no effect.

If neither the methods nor the field are found on the class a NoSuchPropertyException exception will be thrown.

public void set (T object, V value)

Added in API level 14

Sets the value on object which this property represents. If the method is unable to set the value on the target object it will throw an UnsupportedOperationException exception.

Results

Interfaces

Classes

Enums

Exceptions

Class Overview

Summary

Public Constructors

public Property (Class<V> type, String name)

Public Methods

public abstract V get (T object)

public String getName ()

public Class<V> getType ()

public boolean isReadOnly ()

public static Property<T, V> of (Class<T> hostType, Class<V> valueType, String name)

public void set (T object, V value)

java.lang.Object
↳	android.util.Property<T, V>