org.testifyproject.FieldDescriptor 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;

import org.testifyproject.trait.FieldTrait;
import org.testifyproject.trait.FieldAnnotationTrait;

/**
 * A contract that defines methods to access properties of or perform operations
 * on a field.
 *
 * @author saden
 */
public interface FieldDescriptor extends FieldTrait, FieldAnnotationTrait {

    /**
     * 
     * Get the explicitly defined field name. Please note that field names are
     * explicitly defined by annotating the field with and specifying:
     * 
     * 
     * {@link org.testifyproject.annotation.Fake#value()}
     * {@link org.testifyproject.annotation.Real#value()}
     * {@link org.testifyproject.annotation.Virtual#value()}
     * 
     * 
     * In the event a field name is not explicitly defined the value returned by
     * calling {@link java.lang.reflect.Field#getName()} will be returned.
     * 
     *
     * @return the field name
     */
    String getDefinedName();

}