core/src/main/java/org/apache/commons/proxy2/invoker/RecordedInvocation.java

/*
 * 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 org.apache.commons.proxy2.invoker;

import java.lang.reflect.Method;

import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.proxy2.ProxyUtils;

/**
 * Detached representation of a method invocation.
 * 
 * @author James Carman
 */
public class RecordedInvocation
{
    //******************************************************************************************************************
    // Fields
    //******************************************************************************************************************

    private final Method invokedMethod;
    private final Object[] arguments;

    //******************************************************************************************************************
    // Constructors
    //******************************************************************************************************************

    /**
     * Create a new RecordedInvocation instance.
     * 
     * @param invokedMethod
     * @param arguments
     */
    public RecordedInvocation(Method invokedMethod, Object[] arguments)
    {
        this.invokedMethod = invokedMethod;
        this.arguments = ArrayUtils.nullToEmpty(ArrayUtils.clone(arguments));
    }

    //******************************************************************************************************************
    // Getter/Setter Methods
    //******************************************************************************************************************

    /**
     * Get the invokedMethod.
     * 
     * @return Method
     */
    public Method getInvokedMethod()
    {
        return invokedMethod;
    }

    //******************************************************************************************************************
    // Canonical Methods
    //******************************************************************************************************************

    /**
     * {@inheritDoc}
     */
    public String toString()
    {
        StringBuilder buffer = new StringBuilder();
        buffer.append(invokedMethod.getDeclaringClass().getName());
        buffer.append(".");
        buffer.append(invokedMethod.getName());
        buffer.append("(");
        int count = arguments.length;
        for (int i = 0; i < count; i++)
        {
            Object arg = arguments[i];
            if (i > 0)
            {
                buffer.append(", ");
            }
            convert(buffer, arg);
        }
        buffer.append(")");
        return buffer.toString();
    }

    //******************************************************************************************************************
    // Other Methods
    //******************************************************************************************************************

    /**
     * Add a string representation of <code>input</code> to <code>buffer</code>.
     * 
     * @param buffer
     * @param input
     */
    protected void convert(StringBuilder buffer, Object input)
    {
        if (input == null)
        {
            buffer.append("<null>");
            return;
        }

        // Primitive types, and non-object arrays
        // use toString().
        if (!(input instanceof Object[]))
        {
            buffer.append(input.toString());
            return;
        }
        buffer.append("(");
        buffer.append(ProxyUtils.getJavaClassName(input.getClass()));
        buffer.append("){");
        Object[] array = (Object[]) input;
        int count = array.length;
        for (int i = 0; i < count; i++)
        {
            if (i > 0)
            {
                buffer.append(", ");
            }
            // We use convert() again, because it could be a multi-dimensional array
            // where each element must be converted.
            convert(buffer, array[i]);
        }
        buffer.append("}");
    }

    /**
     * Get the arguments.
     * 
     * @return Object[]
     */
    public Object[] getArguments()
    {
        return ArrayUtils.clone(arguments);
    }
}