Instance (eXparity Bean 1.0.1 API)

java.lang.Object
- org.exparity.beans.core.Instance

Direct Known Subclasses:

Bean, Graph
```
public abstract class Instance
extends Object
```
Author:

Stewart Bissett

Constructor Summary

Constructors
Modifier Constructor and Description

protected Instance(InstanceInspector inspector, Object instance, BeanNamingStrategy naming)

Constructors
Modifier	Constructor and Description
`protected`	`Instance(InstanceInspector inspector, Object instance, BeanNamingStrategy naming)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`apply(BeanPropertyFunction function)` Apply the `BeanPropertyFunction` to all properties on the supplied instance.
`void`	`apply(BeanPropertyFunction function, BeanPropertyPredicate predicate)` Apply the `BeanPropertyFunction` to all properties which match the predicate in the supplied instances.
`void`	`dump(OutputStream os)` Write out all properties and their values on this object.
`void`	`dump(StringBuffer buffer)` Write out all properties and their values on this object.
`void`	`dump(Writer writer)` Write out all properties and their values on this object.
`List<BeanProperty>`	`find(BeanPropertyPredicate predicate)` Find all property properties which match the predicate.
`BeanProperty`	`findAny(BeanPropertyPredicate predicate)` Find the first instance of the property which matches the given predicate in the instance.
`BeanProperty`	`get(BeanPropertyPredicate predicate)` Get the property which matches the predicate from the instance or return `null` if not matching property is found.
`BeanProperty`	`get(String name)` Get the requested property from the type or return `null` if the property is not present.
`boolean`	`hasProperty(BeanPropertyPredicate predicate)` Test if the supplied instance has a Bean property which matches the given predicate.
`boolean`	`hasProperty(String name)` Test if the supplied instance has a Bean property with the given name.
`boolean`	`hasProperty(String name, Object value)` Test if the supplied instance has a Bean property with the given name and value.
`boolean`	`isPropertyType(BeanPropertyPredicate predicate, Class<?> type)` Test if the property which matches the predicate on the supplied instance is of the supplied type.
`boolean`	`isPropertyType(String name, Class<?> type)` Test if the property on the supplied instance is of the supplied type.
`List<BeanProperty>`	`propertyList()` Return a list of the publicly exposes get/set properties on this instance.
`Map<String,BeanProperty>`	`propertyMap()` Return a map of the publicly exposes get/set properties on the Bean with the property name as the key and the initial character lowercased For example:
`BeanProperty`	`propertyNamed(String name)` Get the requested property from the instance or return `null` if the property is not present.
`Class<?>`	`propertyType(BeanPropertyPredicate predicate)` Return the property type on the instance for the first property which matches the supplied predicate or `null` if no matching properties are found.
`Class<?>`	`propertyType(String name)` Return the property type on the instance for the supplied property name or `null` if the property doesn't exist.
`Object`	`propertyValue(BeanPropertyPredicate predicate)` Return the first property value on the instance which matches the predicate or return `null` if the no matching properties are not present on the instance.
`<T> T`	`propertyValue(BeanPropertyPredicate predicate, Class<T> type)` Return the first property value on the instance which matches the predicate or return `null` if the no matching properties are not present on the instance.
`Object`	`propertyValue(String name)` Return the property value on the instance for the supplied property name or return `null` if the property is not present on the instance.
`<T> T`	`propertyValue(String name, Class<T> type)` Return the property value on the instance for the supplied property name or return `null` if the property is not present on the instance.
`void`	`setNamingStrategy(BeanNamingStrategy naming)` Override the default naming strategy
`void`	`setProperty(BeanPropertyPredicate predicate, Object value)` Set the property which matches the predicate on the given instance.
`boolean`	`setProperty(String name, Object value)` Set the requested property on the given instance.
`void`	`visit(BeanVisitor visitor)` Visit the supplied bean or graph instance and notify the visitor for each bean property found.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Instance
```
protected Instance(InstanceInspector inspector,
                   Object instance,
                   BeanNamingStrategy naming)
```
- Method Detail
  - propertyList
```
public List<BeanProperty> propertyList()
```
    Return a list of the publicly exposes get/set properties on this instance. For example to list the properties on :
```
 List<BeanPropertyInstance> properties = bean(myObject).propertyList()
 
```
  - propertyMap
```
public Map<String,BeanProperty> propertyMap()
```
    Return a map of the publicly exposes get/set properties on the Bean with the property name as the key and the initial character lowercased For example:
```
 Map<String, BeanPropertyInstance> propertyMap = bean(myObject).propertyMap()
 
```
  - setProperty
```
public void setProperty(BeanPropertyPredicate predicate,
                        Object value)
```
    Set the property which matches the predicate on the given instance. For example:
```
 bean(myObject).setProperty(BeanPredicates.named("surname"), "Smith")
 
```
    Parameters:
    
    predicate - a predicate to match the properties
    
    value - the property value
  - propertyValue
```
public Object propertyValue(BeanPropertyPredicate predicate)
```
    Return the first property value on the instance which matches the predicate or return null if the no matching properties are not present on the instance. For example:
```
 Object value = bean(myObject).propertyValue(BeanPredicates.named("surname")))
 
```
    Parameters:
    
    instance - an object to get the property from
    
    name - the property name
  - propertyValue
```
public <T> T propertyValue(BeanPropertyPredicate predicate,
                           Class<T> type)
```
    Return the first property value on the instance which matches the predicate or return null if the no matching properties are not present on the instance. For example:
```
 String value = bean(myObject).propertyValue(BeanPredicates.named("surname")), String.class)
 
```
    Parameters:
    
    predicate - a predicate to match the properties
    
    type - the type to return the property value as
  - propertyValue
```
public Object propertyValue(String name)
```
    Return the property value on the instance for the supplied property name or return null if the property is not present on the instance. For example:
```
 Object value = bean(myObject).propertyValue("surname"))
 
```
    Parameters:
    
    name - the property name
  - propertyValue
```
public <T> T propertyValue(String name,
                           Class<T> type)
```
    Return the property value on the instance for the supplied property name or return null if the property is not present on the instance. For example:
```
 String value = bean(myObject).propertyValue("surname", String.class))
 
```
    Parameters:
    
    name - the property name
    
    type - the type to return the property value as
  - hasProperty
```
public boolean hasProperty(BeanPropertyPredicate predicate)
```
    Test if the supplied instance has a Bean property which matches the given predicate. For example:
```
 if ( bean(myObject).hasProperty(aUser, BeanPredicates.named("surname")))) {
        // Do Something
 }
 
```
    Parameters:
    
    predicate - the predicate to select the property with
  - get
```
public BeanProperty get(String name)
```
    Get the requested property from the type or return null if the property is not present. For example:
```
 BeanPropertyInstance surname = bean(myObject).get("surname")
 
```
    Parameters:
    
    name - the property name
  - get
```
public BeanProperty get(BeanPropertyPredicate predicate)
```
    Get the property which matches the predicate from the instance or return null if not matching property is found. For example:
```
 BeanPropertyInstance surname = bean(myObject).get(BeanPredicates.named("surname"))
 
```
    Parameters:
    
    predicate - a predicate to match the property
  - propertyNamed
```
public BeanProperty propertyNamed(String name)
```
    Get the requested property from the instance or return null if the property is not present. For example:
```
 BeanPropertyInstance surname = bean(myObject).propertyNamed("surname")
 
```
    Parameters:
    
    name - the property name
  - propertyType
```
public Class<?> propertyType(String name)
```
    Return the property type on the instance for the supplied property name or null if the property doesn't exist. For example:
```
 if (String.class.equals(bean(myObject).propertyType("surname"))) {
        // Do something
 }
 
```
    Parameters:
    
    name - the property name
  - propertyType
```
public Class<?> propertyType(BeanPropertyPredicate predicate)
```
    Return the property type on the instance for the first property which matches the supplied predicate or null if no matching properties are found. For example:
```
 if (String.class.equals(bean(myObject).propertyType(BeanPredicates.named("surname")))) {
        // Do something
 }
 
```
    Parameters:
    
    predicate - a predicate to match the properties
  - findAny
```
public BeanProperty findAny(BeanPropertyPredicate predicate)
```
    Find the first instance of the property which matches the given predicate in the instance. For example
```
 BeanPropertyInstance property = bean(myObject).findAny(BeanPredicates.withValue("name" "Bob"))
 
```
    Parameters:
    
    predicate - a predicate to match the properties
  - apply
```
public void apply(BeanPropertyFunction function)
```
    Apply the BeanPropertyFunction to all properties on the supplied instance. For example
```
 bean(myObject).apply(BeanFunctions.setValue(null))
 
```
    Parameters:
    
    function - the function to apply to the matching properties
  - apply
```
public void apply(BeanPropertyFunction function,
                  BeanPropertyPredicate predicate)
```
    Apply the BeanPropertyFunction to all properties which match the predicate in the supplied instances. For example
```
 bean(myObject).apply(BeanPredicates.ofType(String.class), BeanFunctions.setValue(null))
 
```
    Parameters:
    
    function - the function to apply to the matching properties
    
    predicate - a predicate to match the properties
  - find
```
public List<BeanProperty> find(BeanPropertyPredicate predicate)
```
    Find all property properties which match the predicate. For example
```
 for ( BeanPropertyInstance property : bean(myObject).find(BeanPredicates.ofType(String.class)) {
   property.setValue(null);
 }
 
```
    Parameters:
    
    predicate - a predicate to match the properties
  - visit
```
public void visit(BeanVisitor visitor)
```
    Visit the supplied bean or graph instance and notify the visitor for each bean property found. For example:
```
 bean(myObject).visit(new BeanVisitor() {
 
        public void visit(final BeanPropertyInstance property, final Object current, final BeanPropertyPath path, final Object[] stack) {
                System.out.println(path.fullPath());
        }
 });
 
```
    Parameters:
    
    visitor - the visitor which will be notified of every bean property encountered
  - hasProperty
```
public boolean hasProperty(String name)
```
    Test if the supplied instance has a Bean property with the given name. For example
```
 if ( bean(myObject).hasProperty("surname"))) {
        // Do Something
 }
 
```
    Parameters:
    
    name - the property name
  - hasProperty
```
public boolean hasProperty(String name,
                           Object value)
```
    Test if the supplied instance has a Bean property with the given name and value. For example
```
 if ( bean(myObject).hasProperty("surname","Smith"))) {
        // Do Something
 }
 
```
    Parameters:
    
    name - the property name
    
    value - the value to test for
  - setProperty
```
public boolean setProperty(String name,
                           Object value)
```
    Set the requested property on the given instance. For example:
```
 bean(myObject).setProperty("surname", "Smith")
 
```
    Parameters:
    
    name - the property name
    
    value - the property value
  - isPropertyType
```
public boolean isPropertyType(String name,
                              Class<?> type)
```
    Test if the property on the supplied instance is of the supplied type. For example:
```
 if (bean(myObject).isPropertyType("surname", String.class)) {
        // Do something
 }
 
```
    Parameters:
    
    name - the property name
    
    type - the expected type of the property
  - isPropertyType
```
public boolean isPropertyType(BeanPropertyPredicate predicate,
                              Class<?> type)
```
    Test if the property which matches the predicate on the supplied instance is of the supplied type. For example:
```
 if (bean(myObject).isPropertyType("surname", String.class)) {
        // Do something
 }
 
```
    Parameters:
    
    predicate - a predicate to match the properties
    
    type - the expected type of the property
  - setNamingStrategy
```
public void setNamingStrategy(BeanNamingStrategy naming)
```
    Override the default naming strategy
  - dump
```
public void dump(Writer writer)
```
    Write out all properties and their values on this object.
    
    Parameters:
    
    writer - the writer to write the output to
  - dump
```
public void dump(OutputStream os)
```
    Write out all properties and their values on this object.
    
    Parameters:
    
    os - the stream to write the output to
  - dump
```
public void dump(StringBuffer buffer)
```
    Write out all properties and their values on this object.
    
    Parameters:
    
    buffer - the buffer to append the output to

Class Instance

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Instance

Method Detail

propertyList

propertyMap

setProperty

propertyValue

propertyValue

propertyValue

propertyValue

hasProperty

get

get

propertyNamed

propertyType

propertyType

findAny

apply

apply

find

visit

hasProperty

hasProperty

setProperty

isPropertyType

isPropertyType

setNamingStrategy

dump

dump

dump