com.anrisoftware.globalpom.reflection.beans.BeanAccess Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of globalpomutils-reflection Show documentation
Access Java beans through reflection.
The newest version!
/*
 * Copyright 2014-2025 Erwin Müller 
 *
 * 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.anrisoftware.globalpom.reflection.beans;

import java.beans.PropertyVetoException;
import java.lang.reflect.AccessibleObject;
import java.lang.reflect.Field;
import java.lang.reflect.Method;

import com.anrisoftware.globalpom.reflection.exceptions.ReflectionError;

/**
 * Access the fields of an bean object.
 *
 * @author Erwin Mueller, [email protected]
 * @since 1.4
 */
public interface BeanAccess {

    /**
     * Returns the field.
     *
     * @return the {@link Field} or {@code null} if there is no field.
     */
    Field getField();

    /**
     * Returns the setter method of the bean. The setter method is a method with the
     * signature:
     *
     *      * public void setAttribute(Type value);
     * 
     *
     * @return the {@link Method} of {@code null} if there is no setter method.
     */
    Method getSetter();

    /**
     * Returns the getter method of the bean. The getter method is a method with the
     * signature:
     *
     *      * public Type getAttribute();
     * 
     *
     * @return the {@link Method} of {@code null} if there is no getter method.
     */
    Method getGetter();

    /**
     * Returns the getter method or the field.
     *
     * @return the {@link AccessibleObject}.
     *
     * @since 1.5
     */
    AccessibleObject getGettterObject();

    /**
     * Returns the type of the bean. The type is either the return type of the
     * getter method or the field type.
     *
     * @return the {@link Class} type.
     *
     * @since 1.5
     */
    Class getType();

    /**
     * Return the value from a field with the specified name.
     * 
     * If a getter for this field is defined it tries to use the getter first. A
     * getter is a method with the pattern FieldType getFieldName()
     * where FieldType the type of the field and FieldName
     * the name of the field is.
     * 
     * 
     * If no such getter is defined, the value of the field will be returned by
     * using reflection.
     * 
     *
     * @param  the value type.
     *
     * @return the value of the field.
     *
     * @throws NullPointerException if the specified field name or parent object is
     *                              {@code null}.
     *
     * @throws ReflectionError      if the field can not be found in the parent
     *                              object, the field can not be accessed or the
     *                              getter of the field throws an exception.
     */
     T getValue();

    /**
     * Sets the value to the field.
     *
     * @param value the value to be set.
     *
     * @throws PropertyVetoException if the value is unacceptable by the bean.
     */
    void setValue(Object value) throws PropertyVetoException;

}