com.blazebit.lang.ValueRetriever Maven / Gradle / Ivy

package com.blazebit.lang;

/**
 * ValueRetrievers can be used to access a value of a target object in a
 * stateless manner. {@link ValueRetriever}s are immutable and the methods may
 * throw {@link RuntimeException}s.
 *
 * @param  The type of the target object from which to retrieve the value.
 * @param  The type of the value that is retrieved.
 * @author Christian Beikov
 * @since 1.0
 */
public interface ValueRetriever {

    /**
     * Retrieves the value specified by this ValueRetriever of the target
     * object. Subsequent call may return different values. An implementation
     * may throw {@link RuntimeException}s.
     *
     * @param target The target object from which to retrieve the value.
     * @return The value of the target object.
     */
    public Y getValue(X target);

}