io.microsphere.reflect.MethodDefinition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of microsphere-java-core Show documentation
Microsphere Java Core
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.microsphere.reflect;

import io.microsphere.lang.Deprecation;
import io.microsphere.util.Version;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.lang.reflect.Method;
import java.util.Arrays;

import static io.microsphere.reflect.MethodUtils.findMethod;
import static io.microsphere.reflect.MethodUtils.invokeMethod;

/**
 * The definition class of Java {@link Method}
 *
 * @author Mercy
 * @see Method
 * @see Version
 * @since 1.0.0
 */
public class MethodDefinition extends ExecutableDefinition {

    /**
     * @param since               the 'since' version
     * @param declaredClassName   The declared class name of the method
     * @param methodName          the method name
     * @param parameterClassNames the parameter types
     */
    public MethodDefinition(String since, String declaredClassName, String methodName, String... parameterClassNames) {
        this(since, null, declaredClassName, methodName, parameterClassNames);
    }

    /**
     * @param since               the 'since' version
     * @param deprecation         the deprecation
     * @param declaredClassName   The declared class name of the method
     * @param methodName          the method name
     * @param parameterClassNames the parameter class names
     */
    public MethodDefinition(String since, Deprecation deprecation, String declaredClassName, String methodName, String... parameterClassNames) {
        this(Version.of(since), deprecation, declaredClassName, methodName, parameterClassNames);
    }

    /**
     * @param since               the 'since' version
     * @param declaredClassName   The declared class name of the method
     * @param methodName          the method name
     * @param parameterClassNames the parameter types
     */
    public MethodDefinition(Version since, String declaredClassName, String methodName, String... parameterClassNames) {
        this(since, null, declaredClassName, methodName, parameterClassNames);
    }

    /**
     * @param since               the 'since' version
     * @param deprecation         the deprecation
     * @param declaredClassName   The declared class name of the method
     * @param methodName          the method name
     * @param parameterClassNames the parameter class names
     */
    public MethodDefinition(Version since, Deprecation deprecation, String declaredClassName, String methodName, String... parameterClassNames) {
        super(since, deprecation, declaredClassName, methodName, parameterClassNames);
    }

    /**
     * The method name
     *
     * @return non-null
     */
    @Nonnull
    public String getMethodName() {
        return super.getName();
    }

    /**
     * The resolved method
     *
     * @return null if not resolved
     */
    @Nullable
    public Method getMethod() {
        return super.getMember();
    }

    @Override
    protected Method resolveMember() {
        return findMethod(super.getDeclaredClass(), getMethodName(), super.getParameterTypes());
    }

    /**
     * Invokes the underlying method represented by this {@code Method}
     * object, on the specified object with the specified parameters.
     * Individual parameters are automatically unwrapped to match
     * primitive formal parameters, and both primitive and reference
     * parameters are subject to method invocation conversions as
     * necessary.
     *
     * @param instance the instance for method invocation
     * @param args     the arguments for method invocation
     * @param       the type of return value
     * @return the return value
     * @throws IllegalStateException    if this {@code Method} object
     *                                  is enforcing Java language access control and the underlying
     *                                  method is inaccessible.
     * @throws IllegalArgumentException if the method is an
     *                                  instance method and the specified object argument
     *                                  is not an instance of the class or interface
     *                                  declaring the underlying method (or of a subclass
     *                                  or implementor thereof); if the number of actual
     *                                  and formal parameters differ; if an unwrapping
     *                                  conversion for primitive arguments fails; or if,
     *                                  after possible unwrapping, a parameter value
     *                                  cannot be converted to the corresponding formal
     *                                  parameter type by a method invocation conversion.
     * @throws RuntimeException         if the underlying method
     *                                  throws an exception.
     */
    public  R invoke(Object instance, Object... args) throws IllegalStateException, IllegalArgumentException, RuntimeException {
        return invokeMethod(instance, getMethod(), args);
    }

    @Override
    public String toString() {
        return "MethodDefinition{" +
                "since=" + super.since +
                ", deprecation=" + super.deprecation +
                ", declaredClassName='" + super.getDeclaredClassName() + '\'' +
                ", declaredClass=" + super.getDeclaredClass() +
                ", methodName='" + getMethodName() + '\'' +
                ", method=" + getMethod() +
                ", parameterClassName=" + Arrays.toString(super.parameterClassNames) +
                ", parameterTypes=" + Arrays.toString(super.getParameterTypes()) +
                '}';
    }
}