com.massa.util.property

Interface IProperty

All Superinterfaces:

Serializable

All Known Subinterfaces:

IProperty2

All Known Implementing Classes:

AbstractProperty, ConstantProperty, ConstantProperty2, GlobalVarProperty, IndexedProperty, IndexedProperty2, IntegerProperty, IntegerProperty2, LocalVarProperty, MappedProperty, MappedProperty2, NestedProperty, NestedProperty2, SimpleProperty, SimpleProperty2, StaticFieldProperty, StaticFieldProperty2, StaticMethodProperty, StaticMethodProperty2, StrictFieldProperty, StrictFieldProperty2, StrictMethodProperty, StrictMethodProperty2, StringProperty, StringProperty2

public interface IProperty
extends Serializable

Interface for the different possible properties readers.
All methods taking IPropertySource as a parameter MUST return with this parameter in the same state as when entering the method.
IProperty is thought to be immutable and independent from targeted beans. As a consequence, they should not be cloneable. All implementations should respect this principle.

Method Summary

Modifier and Type	Method and Description
Object	get(IPropertySource source) Introspects source to retrieve property value.
Object	get(IPropertySource source, boolean instanciateAll) Introspects source to retrieve property value.
Class<?>	getGenericCollectionType(IPropertySource source) Tries to detect if the generic type of the property if the type is a Collection, knowing the argument type to use.
Class<?>	getGenericCollectionType(Object source) Tries to detect if the generic type of the property if the type is a Collection, whatever there is an argument or not.
Class<?>	getGenericMapKeyType(IPropertySource source) Tries to detect if the generic key type of the property if the type is a Map, knowing the argument type to use.
Class<?>	getGenericMapKeyType(Object source) Tries to detect if the generic key type of the property if the type is a Map, whatever there is an argument or not.
Class<?>	getGenericMapValueType(IPropertySource source) Tries to detect if the generic value type of the property if the type is a Map, knowing the argument type to use.
Class<?>	getGenericMapValueType(Object source) Tries to detect if the generic value type of the property if the type is a Map, whatever there is an argument or not.
Class<?>[]	getGenericTypes(IPropertySource source) Tries to detect if the parameterized types of the property, whatever its type is, knowing the argument type to use.
Class<?>[]	getGenericTypes(Object source) Tries to detect if the parameterized types of the property, whatever its type is, whatever there is an argument or not.
Class<?>	getType(IPropertySource source) Tries to detect if the type of the property, knowing the argument type to use.
Class<?>	getType(Object source) Tries to detect if the type of the property, whatever there is an argument or not.
boolean	isReadable(IPropertySource source) Tries to detect if the property will be able to be read in theory, knowing the argument type to use.
boolean	isReadable(Object source) Tries to detect if the property will be able to be read in theory, whatever there is an argument or not.
boolean	isWriteable(IPropertySource target) Tries to detect if the property will be able to be written in theory, knowing the argument type to use.
boolean	isWriteable(Object target) Tries to detect if the property will be able to be written in theory, whatever there is an argument or not.
Object	set(IPropertySource target, Object obj) Introspects target to set property value.
Object	set(IPropertySource target, Object obj, boolean instanciateNested) Introspects target to set property value.

Method Detail

get

Object get(IPropertySource source)
    throws UtilsException

Introspects source to retrieve property value. If a nested property is null, returns null.

Parameters:

source - Source context to introspect.

Throws:

UtilsException

get

Object get(IPropertySource source,
           boolean instanciateAll)
    throws UtilsException

Introspects source to retrieve property value. If a nested property is null, tries if requested to instantiate all hierarchy. If this process fails, an exception is raised. If not requested, returns null.

Parameters:

source - Source context to introspect.

instanciateAll - whether to try or not to instantiate null nested properties values.

Throws:

UtilsException

set

Object set(IPropertySource target,
           Object obj)
    throws UtilsException

Introspects target to set property value. Tries to instantiate null nested properties. If it fails, an exception is raised.

Parameters:

target - Source context to introspect.

obj - Value to set

Returns:

Real set value (after eventual cast)

Throws:

UtilsException

set

Object set(IPropertySource target,
           Object obj,
           boolean instanciateNested)
    throws UtilsException

Introspects target to set property value. Tries to instantiate null nested properties if requested. If it fails, an exception is raised. If not requested, an exception is directly raised in case of null nested property.

Parameters:

target - Source context to introspect.

obj - Value to set

instanciateNested - whether to try or not to instantiate null nested properties values.

Returns:

Real set value (after eventual cast)

Throws:

UtilsException

isReadable

boolean isReadable(Object source)
            throws UtilsException

Tries to detect if the property will be able to be read in theory, whatever there is an argument or not. When undefined, returns true, so that real case will be detected at runtime.

Parameters:

source - Source class to introspect.

Throws:

UtilsException

isReadable

boolean isReadable(IPropertySource source)
            throws UtilsException

Tries to detect if the property will be able to be read in theory, knowing the argument type to use. Might be based on a real bean or only on a type. When undefined, returns true, so that real case will be detected at runtime.

Parameters:

source - Source context to introspect.

Throws:

UtilsException

isWriteable

boolean isWriteable(Object target)
             throws UtilsException

Tries to detect if the property will be able to be written in theory, whatever there is an argument or not. When undefined, returns true, so that real case will be detected at runtime.

Parameters:

target - Source class to introspect.

Throws:

UtilsException

isWriteable

boolean isWriteable(IPropertySource target)
             throws UtilsException

Tries to detect if the property will be able to be written in theory, knowing the argument type to use. Might be based on a real bean or only on a type. When undefined, returns true, so that real case will be detected at runtime.

Parameters:

target - Source context to introspect.

Throws:

UtilsException

getType

Class<?> getType(Object source)
          throws UtilsException

Tries to detect if the type of the property, whatever there is an argument or not. If impossible, returns null.

Parameters:

source - Source context to introspect.

Throws:

UtilsException

getType

Class<?> getType(IPropertySource source)
          throws UtilsException

Tries to detect if the type of the property, knowing the argument type to use. If impossible, returns null.

Parameters:

source - Source context to introspect.

Throws:

UtilsException

getGenericCollectionType

Class<?> getGenericCollectionType(Object source)
                           throws UtilsException

Tries to detect if the generic type of the property if the type is a Collection, whatever there is an argument or not. If impossible, returns null.

Parameters:

source - Source context to introspect.

Throws:

UtilsException

getGenericCollectionType

Class<?> getGenericCollectionType(IPropertySource source)
                           throws UtilsException

Tries to detect if the generic type of the property if the type is a Collection, knowing the argument type to use. If impossible, returns null.

Parameters:

source - Source context to introspect.

Throws:

UtilsException

getGenericTypes

Class<?>[] getGenericTypes(Object source)
                    throws UtilsException

Tries to detect if the parameterized types of the property, whatever its type is, whatever there is an argument or not. If impossible, returns null.

Parameters:

source - Source context to introspect.

Throws:

UtilsException

Since:

1.2.0

getGenericTypes

Class<?>[] getGenericTypes(IPropertySource source)
                    throws UtilsException

Tries to detect if the parameterized types of the property, whatever its type is, knowing the argument type to use. If impossible, returns null.

Parameters:

source - Source context to introspect.

Throws:

UtilsException

Since:

1.2.0

getGenericMapKeyType

Class<?> getGenericMapKeyType(Object source)
                       throws UtilsException

Tries to detect if the generic key type of the property if the type is a Map, whatever there is an argument or not. If impossible, returns null.

Parameters:

source - Source context to introspect.

Throws:

UtilsException

getGenericMapKeyType

Class<?> getGenericMapKeyType(IPropertySource source)
                       throws UtilsException

Tries to detect if the generic key type of the property if the type is a Map, knowing the argument type to use. If impossible, returns null.

Parameters:

source - Source context to introspect.

Throws:

UtilsException

getGenericMapValueType

Class<?> getGenericMapValueType(Object source)
                         throws UtilsException

Tries to detect if the generic value type of the property if the type is a Map, whatever there is an argument or not. If impossible, returns null.

Parameters:

source - Source context to introspect.

Throws:

UtilsException

getGenericMapValueType

Class<?> getGenericMapValueType(IPropertySource source)
                         throws UtilsException

Tries to detect if the generic value type of the property if the type is a Map, knowing the argument type to use. If impossible, returns null.

Parameters:

source - Source context to introspect.

Throws:

UtilsException