XRayInterface (net.amygdalum:xrayinterface 0.3.5 API)

java.lang.Object
- net.amygdalum.xrayinterface.InvocationResolver
- - net.amygdalum.xrayinterface.XRayInterface

All Implemented Interfaces:: InvocationHandler

public class XRayInterface
extends InvocationResolver
implements InvocationHandler

XRay is a Decorator for any object (or class) that should get a new public interface. Usage:

InterfaceOfTheDecorator unlocked = XRayInterface.xray(object).to(InterfaceOfTheDecorator.class);

After that the variable unlocked contains an object of type InterfaceOfTheDecorator, where each method is mapped according to the xrayinterface conventions:

mapping conventions
Method	Maps to
`void setProperty([sometype] t)`	`void setProperty([sometype] t)`	if exists
	`property = t;`	if there is a property `[sometype]` property;
`[sometype] getProperty()`	`[sometype] getProperty()`	if exists
	`return property;`	if there is a property `[sometype]` property;
`[booleantype] isProperty()`	`[booleantype] getProperty()`	if exists
	`return property;`	if there is a property `[booleantype]` property;
`[return type] methodname([signature])`	`[return type] methodname([signature])`

Author:: Stefan Mandel

Constructor Summary

Constructors
Constructor and Description

XRayInterface(Class<?> clazz)

XRayInterface(Object object)

Constructors
Constructor and Description
`XRayInterface(Class<?> clazz)`
`XRayInterface(Object object)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`List<ConstructorInvoker>`	`getConstructors()`
`List<FieldGetter>`	`getFieldGetters()`
`List<FieldProperty>`	`getFieldProperties()`
`List<FieldSetter>`	`getFieldSetters()`
`Map<Method,MethodInvocationHandler>`	`getInterfaceMethods()`
`List<MethodInvoker>`	`getMethods()`
`Object`	`getObject()`
`List<StaticGetter>`	`getStaticGetters()`
`List<StaticMethodInvoker>`	`getStaticMethods()`
`List<StaticProperty>`	`getStaticProperties()`
`List<StaticSetter>`	`getStaticSetters()`
`int`	`hashCode()`
`Object`	`invoke(Object proxy, Method method, Object[] args)`
`<T> T`	`to(Class<T> interfaceClass)` maps the given interface to the wrapped object
`List<Method>`	`unMappable(Class<?> interfaceClazz)` collects all methods of the given interface conflicting with the wrapped object
`static XRayInterface`	`xray(Object object)` wraps the given object.

Methods inherited from class net.amygdalum.xrayinterface.InvocationResolver
createConstructorInvocator, createGetterInvocator, createMethodInvocator, createSetterInvocator, findConstructor, findField, findInvocationHandler, findMethod, getType, resolveSignature

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

Constructor Detail

XRayInterface
```
public XRayInterface(Object object)
```

XRayInterface
```
public XRayInterface(Class<?> clazz)
```

Method Detail
- getInterfaceMethods
```
public Map<Method,MethodInvocationHandler> getInterfaceMethods()
```
- getConstructors
```
public List<ConstructorInvoker> getConstructors()
```
- getFieldProperties
```
public List<FieldProperty> getFieldProperties()
```
- getFieldSetters
```
public List<FieldSetter> getFieldSetters()
```
- getFieldGetters
```
public List<FieldGetter> getFieldGetters()
```
- getStaticProperties
```
public List<StaticProperty> getStaticProperties()
```
- getStaticSetters
```
public List<StaticSetter> getStaticSetters()
```
- getStaticGetters
```
public List<StaticGetter> getStaticGetters()
```
- getMethods
```
public List<MethodInvoker> getMethods()
```
- getStaticMethods
```
public List<StaticMethodInvoker> getStaticMethods()
```
- getObject
```
public Object getObject()
```
- xray
```
public static XRayInterface xray(Object object)
```
  wraps the given object. The result of this method will be decoratable with the new interface
  
  Parameters:
  
  object - the object to unlock/decorate
  
  Returns:
  
  the wrapped object
- to
```
public <T> T to(Class<T> interfaceClass)
```
  maps the given interface to the wrapped object
  
  Type Parameters:
  
  T - the type to wrap the object in
  
  Parameters:
  
  interfaceClass - the given interface class (defining the type of the result)
  
  Returns:
  
  an object of the type of interfaceClass (mapped to the members of the wrapped object)
- unMappable
```
public List<Method> unMappable(Class<?> interfaceClazz)
```
  collects all methods of the given interface conflicting with the wrapped object
  
  Parameters:
  
  interfaceClazz - the interface to check on conflicts
  
  Returns:
  
  a list of methods conflicting
- invoke
```
public Object invoke(Object proxy,
                     Method method,
                     Object[] args)
              throws Throwable
```
  Specified by:
  
  invoke in interface InvocationHandler
  
  Throws:
  
  Throwable
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- equals
```
public boolean equals(Object obj)
```
  Overrides:
  
  equals in class Object

Class XRayInterface

Constructor Summary

Method Summary

Methods inherited from class net.amygdalum.xrayinterface.InvocationResolver

Methods inherited from class java.lang.Object

Constructor Detail

XRayInterface

XRayInterface

Method Detail

getInterfaceMethods

getConstructors

getFieldProperties

getFieldSetters

getFieldGetters

getStaticProperties

getStaticSetters

getStaticGetters

getMethods

getStaticMethods

getObject

xray

to

unMappable

invoke

hashCode

equals