okhttp3.internal.platform

Class OptionalMethod<T>

java.lang.Object

okhttp3.internal.platform.OptionalMethod<T>

Type Parameters:

T - the type of the object the method might be on, typically an interface or base class

class OptionalMethod<T>
extends java.lang.Object

Duck-typing for methods: Represents a method that may or may not be present on an object.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	methodName
private java.lang.Class[]	methodParams
private java.lang.Class<?>	returnType The return type of the method.

Constructor Summary

Constructors

Constructor and Description
OptionalMethod(java.lang.Class<?> returnType, java.lang.String methodName, java.lang.Class... methodParams) Creates an optional method.

Method Summary

Modifier and Type	Method and Description
private java.lang.reflect.Method	getMethod(java.lang.Class<?> clazz) Perform a lookup for the method.
private static java.lang.reflect.Method	getPublicMethod(java.lang.Class<?> clazz, java.lang.String methodName, java.lang.Class[] parameterTypes)
java.lang.Object	invoke(T target, java.lang.Object... args) Invokes the method on target with args.
java.lang.Object	invokeOptional(T target, java.lang.Object... args) Invokes the method on target with args.
java.lang.Object	invokeOptionalWithoutCheckedException(T target, java.lang.Object... args) Invokes the method on target.
java.lang.Object	invokeWithoutCheckedException(T target, java.lang.Object... args) Invokes the method on target.
boolean	isSupported(T target) Returns true if the method exists on the supplied target.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

returnType

private final java.lang.Class<?> returnType

The return type of the method. null means "don't care".

methodName

private final java.lang.String methodName

methodParams

private final java.lang.Class[] methodParams

Constructor Detail

OptionalMethod

OptionalMethod(java.lang.Class<?> returnType,
               java.lang.String methodName,
               java.lang.Class... methodParams)

Creates an optional method.

Parameters:

returnType - the return type to required, null if it does not matter

methodName - the name of the method

methodParams - the method parameter types

Method Detail

isSupported

public boolean isSupported(T target)

Returns true if the method exists on the supplied target.

invokeOptional

public java.lang.Object invokeOptional(T target,
                                       java.lang.Object... args)
                                throws java.lang.reflect.InvocationTargetException

Invokes the method on target with args. If the method does not exist or is not public then null is returned. See also invokeOptionalWithoutCheckedException(T, java.lang.Object...).

Throws:

java.lang.IllegalArgumentException - if the arguments are invalid

java.lang.reflect.InvocationTargetException - if the invocation throws an exception

invokeOptionalWithoutCheckedException

public java.lang.Object invokeOptionalWithoutCheckedException(T target,
                                                              java.lang.Object... args)

Invokes the method on target. If the method does not exist or is not public then null is returned. Any RuntimeException thrown by the method is thrown, checked exceptions are wrapped in an AssertionError.

Throws:

java.lang.IllegalArgumentException - if the arguments are invalid

invoke

public java.lang.Object invoke(T target,
                               java.lang.Object... args)
                        throws java.lang.reflect.InvocationTargetException

Invokes the method on target with args. Throws an error if the method is not supported. See also invokeWithoutCheckedException(Object, Object...).

Throws:

java.lang.IllegalArgumentException - if the arguments are invalid

java.lang.reflect.InvocationTargetException - if the invocation throws an exception

invokeWithoutCheckedException

public java.lang.Object invokeWithoutCheckedException(T target,
                                                      java.lang.Object... args)

Invokes the method on target. Throws an error if the method is not supported. Any RuntimeException thrown by the method is thrown, checked exceptions are wrapped in an AssertionError.

Throws:

java.lang.IllegalArgumentException - if the arguments are invalid

getMethod

private java.lang.reflect.Method getMethod(java.lang.Class<?> clazz)

Perform a lookup for the method. No caching. In order to return a method the method name and arguments must match those specified when the OptionalMethod was created. If the return type is specified (i.e. non-null) it must also be compatible. The method must also be public.

getPublicMethod

private static java.lang.reflect.Method getPublicMethod(java.lang.Class<?> clazz,
                                                        java.lang.String methodName,
                                                        java.lang.Class[] parameterTypes)