Type (eXparity Bean 1.0.1 API)

java.lang.Object
- org.exparity.beans.Type

All Implemented Interfaces:: Typed

public class Type
extends Object
implements Typed

Author:: Stewart.Bissett

Constructor Summary

Constructors
Constructor and Description

Type(Class<?> type)

Type(Class<?> type, BeanNamingStrategy naming, BeanPropertyOrderingStrategy orderBy)

Constructors
Constructor and Description
`Type(Class<?> type)`
`Type(Class<?> type, BeanNamingStrategy naming, BeanPropertyOrderingStrategy orderBy)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<ImmutableTypeProperty>`	`accessorList()` Return a list of the accessors exposed on this type
`String`	`camelName()` Return the name of the type using camel notation.
`String`	`canonicalName()` Return the full name of the type.
`String`	`componentName()` Return the name for the `Class.getComponentType()`, For a scalar Class this returns the same as `canonicalName()` but for an array it this return the class simple name but without the [].
`String`	`componentSimpleName()` Return the simple name for the `Class.getComponentType()`, For a scalar Class this returns the same as `simpleName()` but for an array it this return the class simple name but without the [].
`TypeProperty`	`get(String name)` Get the requested property from the type or return `null` if the property is not present.
`Method`	`getAccessor(String name)` Return the accessor Method for the given property.
`Class<?>`	`getType()` Return the `Class` for this type
`boolean`	`hasProperty(String name)` Test if the supplied type has a property with the given name.
`boolean`	`is(Class<?> otherType)` Return `true` if this type is the same type or a subclass of the other type.
`boolean`	`isArray()` Return `true` if this type is an array
`boolean`	`isEnum()` Return `true` if this type is a Java enumeration
`boolean`	`isPrimitive()` Return `true` if this type is a primitive type
`boolean`	`isPropertyType(String name, Class<?> type)` Test if the property on the type is of the supplied type.
`String`	`packageName()` Return the package name for this type.
`List<TypeProperty>`	`propertyList()` Return a list of the publicly exposes get/set properties on a class.
`Map<String,TypeProperty>`	`propertyMap()` Return a map of the publicly exposes get/set properties on the type with the property name as the key and the initial character lowercased For example:
`TypeProperty`	`propertyNamed(String propertyName)` Get the requested property from the type or return `null` if the property is not present.
`Class<?>`	`propertyType(String name)` Return the property type on the type for the supplied property name or `null` if the property doesn't exist.
`String`	`simpleName()` Return the name of the type without any package information.
`Class<?>[]`	`superTypes()` Return this type's super types as an array of `Class` instances
`String`	`toString()`
`static Type`	`type(Class<?> type)`
`static Type`	`type(Class<?> type, BeanNamingStrategy naming)`
`static Type`	`type(Object instance)`
`static Type`	`type(Object instance, BeanNamingStrategy naming)`
`Class<?>[]`	`typeHierachy()` Return this type and it's super types as an array of `Class` instances
`static TypeProperty`	`typeProperty(Class<?> instance, String name)` Static factory method for constructing a `TypeProperty` for the property name on the given class.
`void`	`visit(TypeVisitor visitor)` Visit the supplied class and notify the visitor for each bean property found.

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

- Constructor Detail
  - Type
```
public Type(Class<?> type)
```
  - Type
```
public Type(Class<?> type,
            BeanNamingStrategy naming,
            BeanPropertyOrderingStrategy orderBy)
```
- Method Detail
  - type
```
public static Type type(Class<?> type)
```
  - type
```
public static Type type(Class<?> type,
                        BeanNamingStrategy naming)
```
  - type
```
public static Type type(Object instance)
```
  - type
```
public static Type type(Object instance,
                        BeanNamingStrategy naming)
```
  - typeProperty
```
public static final TypeProperty typeProperty(Class<?> instance,
                                              String name)
```
    Static factory method for constructing a TypeProperty for the property name on the given class.
  - camelName
```
public String camelName()
```
    Description copied from interface: Typed
    
    Return the name of the type using camel notation. For example the class my.package.MyObject would have the camelName myObject.
    
    Specified by:
    
    camelName in interface Typed
  - simpleName
```
public String simpleName()
```
    Description copied from interface: Typed
    
    Return the name of the type without any package information. For example the class my.package.MyObject would have the name MyObject.
    
    Specified by:
    
    simpleName in interface Typed
  - componentName
```
public String componentName()
```
    Return the name for the Class.getComponentType(), For a scalar Class this returns the same as canonicalName() but for an array it this return the class simple name but without the [].
  - componentSimpleName
```
public String componentSimpleName()
```
    Return the simple name for the Class.getComponentType(), For a scalar Class this returns the same as simpleName() but for an array it this return the class simple name but without the [].
  - canonicalName
```
public String canonicalName()
```
    Description copied from interface: Typed
    
    Return the full name of the type. For example the class my.package.MyObject would have the name my.package.MyObject.
    
    Specified by:
    
    canonicalName in interface Typed
  - hasProperty
```
public boolean hasProperty(String name)
```
    Test if the supplied type has a property with the given name. For example:
```
 if ( type(MyObject.class).hasProperty("surname"))) {
        // Do Something;
 }
 
```
    Parameters:
    
    name - the property name
  - isPropertyType
```
public boolean isPropertyType(String name,
                              Class<?> type)
```
    Test if the property on the type is of the supplied type. For example:
```
 if (bean(MyObject.class).isPropertyType("surname", String.class)) {
        // Do something
 }
 
```
    Parameters:
    
    name - the property name
    
    type - the expected type of the property
  - visit
```
public void visit(TypeVisitor visitor)
```
    Visit the supplied class and notify the visitor for each bean property found. For example:
```
 type(MyObject.class).visit(new TypeVisitor() {
 
        public void visit(final TypeProperty property) {
                System.out.println(property.getName());
        }
 });
 
```
    Parameters:
    
    type - the type to get the property from
    
    visitor - the visitor which will be notified of every bean property encountered
  - propertyList
```
public List<TypeProperty> propertyList()
```
    Return a list of the publicly exposes get/set properties on a class. For example:
```
 List<TypeProperty> properties = Type.type(MyObject.class).propertyList()
 
```
  - accessorList
```
public List<ImmutableTypeProperty> accessorList()
```
    Return a list of the accessors exposed on this type
  - propertyMap
```
public Map<String,TypeProperty> propertyMap()
```
    Return a map of the publicly exposes get/set properties on the type with the property name as the key and the initial character lowercased For example:
```
 Map<String, BeanProperty> propertyMap = Bean.bean(MyObject.class).propertyMap()
 
```
  - propertyNamed
```
public TypeProperty propertyNamed(String propertyName)
```
    Get the requested property from the type or return null if the property is not present. For example:
```
 TypeProperty surname = type(MyObject.class).propertyNamed(MyObject.class, "surname")
 
```
    Parameters:
    
    name - the property name
  - get
```
public TypeProperty get(String name)
```
    Get the requested property from the type or return null if the property is not present. For example:
```
 TypeProperty surname = type(MyObject.class).get("surname")
 
```
    Parameters:
    
    name - the property name
  - propertyType
```
public Class<?> propertyType(String name)
```
    Return the property type on the type for the supplied property name or null if the property doesn't exist. For example:
```
 if (String.class.equals(type(MyObject.class).propertyType("surname"))) {
        // Do something
 }
 
```
    Parameters:
    
    name - the property name
  - getAccessor
```
public Method getAccessor(String name)
```
    Return the accessor Method for the given property. For example
```
 Method method = type(MyObject).getAccessor("surname")
 
```
    Parameters:
    
    name - the property name
    
    Throws:
    
    BeanPropertyNotFoundException - if the property is not found
  - typeHierachy
```
public Class<?>[] typeHierachy()
```
    Description copied from interface: Typed
    
    Return this type and it's super types as an array of Class instances
    
    Specified by:
    
    typeHierachy in interface Typed
  - superTypes
```
public Class<?>[] superTypes()
```
    Description copied from interface: Typed
    
    Return this type's super types as an array of Class instances
    
    Specified by:
    
    superTypes in interface Typed
  - is
```
public boolean is(Class<?> otherType)
```
    Return true if this type is the same type or a subclass of the other type.
    
    Specified by:
    
    is in interface Typed
  - isArray
```
public boolean isArray()
```
    Description copied from interface: Typed
    
    Return true if this type is an array
    
    Specified by:
    
    isArray in interface Typed
  - packageName
```
public String packageName()
```
    Description copied from interface: Typed
    
    Return the package name for this type. For example the class my.package.MyObject would have the name my.package
    
    Specified by:
    
    packageName in interface Typed
  - isPrimitive
```
public boolean isPrimitive()
```
    Description copied from interface: Typed
    
    Return true if this type is a primitive type
    
    Specified by:
    
    isPrimitive in interface Typed
  - isEnum
```
public boolean isEnum()
```
    Description copied from interface: Typed
    
    Return true if this type is a Java enumeration
    
    Specified by:
    
    isEnum in interface Typed
  - getType
```
public Class<?> getType()
```
    Description copied from interface: Typed
    
    Return the Class for this type
    
    Specified by:
    
    getType in interface Typed
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Type

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Type

Type

Method Detail

type

type

type

type

typeProperty

camelName

simpleName

componentName

componentSimpleName

canonicalName

hasProperty

isPropertyType

visit

propertyList

accessorList

propertyMap

propertyNamed

get

propertyType

getAccessor

typeHierachy

superTypes

is

isArray

packageName

isPrimitive

isEnum

getType

toString