org.jlib.value.Accessor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jlib-value Show documentation

jlib framework providing means to carry, name and modify values in a call-by-reference-like manner

The newest version!

/*
 * jlib - Open Source Java Library
 *
 *     www.jlib.org
 *
 *
 *     Copyright 2005-2018 Igor Akkerman
 *
 *     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.jlib.value;

import java.util.function.Supplier;

/**
 * Accessor of a {@link Value}. {@link Accessor#get()} differs from {@link Supplier#get()} by declaring the checked
 * {@link NotAccessibleException}.
 *
 * @param 
 *        type of the value
 *
 * @author Igor Akkerman
 */
public interface Accessor {

    /**
     * Returns the accessed {@link Value}.
     *
     * @return accessed {@link Value}
     *
     * @throws NotAccessibleException
     *         if no {@link Value} can be accessed
     */
    Value get()
        throws NotAccessibleException;
}