org.testifyproject.trait.MemberTrait Maven / Gradle / Ivy

Go to download

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

A module that provides Testify's annotations

There is a newer version: 1.0.6

/*
 * Copyright 2016-2017 Testify Project.
 *
 * 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 org.testifyproject.trait;

import java.lang.reflect.Member;

/**
 * A contract that specifies member traits.
 *
 * @author saden
 * @param  the member type
 */
public interface MemberTrait {

    /**
     * Get the member.
     *
     * @return the member.
     */
    T getMember();

    /**
     * Get the member name.
     *
     * @return the member name.
     */
    default String getName() {
        return getMember().getName();
    }

    /**
     * Get the class the member is declared in.
     *
     * @return the member declaring class.
     */
    default Class getDeclaringClass() {
        return getMember().getDeclaringClass();
    }

    /**
     * Get the name of the class the member is declared in.
     *
     * @return the member declaring class name.
     */
    default String getDeclaringClassName() {
        return getDeclaringClass().getSimpleName();
    }

    /**
     * Get the member's declaring class' classloader.
     *
     * @return the declaring class' classloader.
     */
    default ClassLoader getDeclaringClassLoader() {
        return getDeclaringClass().getClassLoader();
    }

}