com.palantir.tritium.event.InvocationContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tritium-api Show documentation

Palantir open source project

The newest version!

/*
 * (c) Copyright 2017 Palantir Technologies Inc. All rights reserved.
 *
 * Licensed 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 com.palantir.tritium.event;

import java.lang.reflect.Method;
import javax.annotation.Nullable;

/** Represents the state when an invocation event occurred. */
public interface InvocationContext {

    /**
     * Returns the invocation start time in nanoseconds local to this machine.
     *
     * @return start time
     */
    long getStartTimeNanos();

    /**
     * Returns the instance a method was invoked upon.
     *
     * @return instance invoked or null if a static method
     */
    @Nullable
    Object getInstance();

    /**
     * Returns the method invoked.
     *
     * @return method invoked
     */
    Method getMethod();

    /**
     * Returns the array of arguments for the specified invocation.
     *
     * @return arguments
     */
    Object[] getArgs();
}