Top Description Fields Constructors Methods
com.sun.javafx.property

public final Class PropertyReference<T>

extends Object
Class Inheritance
Imports
java.lang.reflect.Method, .Modifier, javafx.beans.property.ReadOnlyProperty, com.sun.javafx.reflect.ReflectUtil

A handle to a specific property defined on some Bean.

Field Summary

Modifier and TypeField and Description
private Class<?>
private Method
private String
private Method
private boolean
private Method
private Class<?>

Constructor Summary

AccessConstructor and Description
public
PropertyReference(Class<?>
The class of the Bean that contains the property
clazz
,
String
The name of the property
name
)

Creates a new PropertyReference for a property of a bean.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object obj)

Overrides java.lang.Object.equals.

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

public T

Returns:

The value of the property
get
(Object
The Bean instance for which the property should be read
bean
)

Get the value of the property.

public Class<?>

Returns:

the class of the Bean
getContainingClass
()

Returns the class of the Bean that contains the property.

public String

Returns:

name of the propery
getName
()

Returns the name of the property.

public ReadOnlyProperty<T>

Returns:

The ObservableValue of the property
getProperty
(Object
The Bean instance for which the property should be read
bean
)

Get the javafx.beans.value.ObservableValue implementation of the property.

public Class<?>

Returns:

the type of the property
getType
()

Returns the type of the property.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
hasProperty()

Can be used to determine if a property provides an implementation of javafx.beans.value.ObservableValue.

public boolean

Returns:

true, if the property can be get, false otherwise
isReadable
()

Can be used to determine if a property can be get.

public boolean

Returns:

true, if the property can be set, false otherwise
isWritable
()

Can be used to determine if a property can be set.

private void
public void
set(Object
The Bean instance for which the property should be set
bean
,
T
The new value
value
)

Set the property to a new value.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

clazzback to summary
private Class<?> clazz
getterback to summary
private Method getter
nameback to summary
private String name
propertyGetterback to summary
private Method propertyGetter
reflectedback to summary
private boolean reflected
setterback to summary
private Method setter
typeback to summary
private Class<?> type

Constructor Detail

PropertyReferenceback to summary
public PropertyReference(Class<?> clazz, String name)

Creates a new PropertyReference for a property of a bean.

Parameters
clazz:Class<?>

The class of the Bean that contains the property

name:String

The name of the property

Exceptions
NullPointerException:
if clazz or name are null
IllegalArgumentException:
if name is an empty String

Method Detail

equalsback to summary
public boolean equals(Object obj)

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
getback to summary
public T get(Object bean)

Get the value of the property.

Parameters
bean:Object

The Bean instance for which the property should be read

Returns:T

The value of the property

Annotations
@SuppressWarnings:unchecked
Exceptions
IllegalStateException:
if the property is not readable
getContainingClassback to summary
public Class<?> getContainingClass()

Returns the class of the Bean that contains the property.

Returns:Class<?>

the class of the Bean

getNameback to summary
public String getName()

Returns the name of the property.

Returns:String

name of the propery

getPropertyback to summary
public ReadOnlyProperty<T> getProperty(Object bean)

Get the javafx.beans.value.ObservableValue implementation of the property.

Parameters
bean:Object

The Bean instance for which the property should be read

Returns:ReadOnlyProperty<T>

The ObservableValue of the property

Annotations
@SuppressWarnings:unchecked
Exceptions
IllegalStateException:
if the property does not provide an implementation
getTypeback to summary
public Class<?> getType()

Returns the type of the property. This type is only evaluated correctly if a getter or a setter was found.

Returns:Class<?>

the type of the property

hashCodeback 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
hasPropertyback to summary
public boolean hasProperty()

Can be used to determine if a property provides an implementation of javafx.beans.value.ObservableValue.

isReadableback to summary
public boolean isReadable()

Can be used to determine if a property can be get.

Returns:boolean

true, if the property can be get, false otherwise

isWritableback to summary
public boolean isWritable()

Can be used to determine if a property can be set.

Returns:boolean

true, if the property can be set, false otherwise

reflectback to summary
private void reflect()
setback to summary
public void set(Object bean, T value)

Set the property to a new value.

Parameters
bean:Object

The Bean instance for which the property should be set

value:T

The new value

Exceptions
IllegalStateException:
if the property is not writable
toStringback 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