001/*
002 * ============================================================================
003 * Copyright © 2002-2020 by Thomas Thrien.
004 * All Rights Reserved.
005 * ============================================================================
006 *
007 * Licensed to the public under the agreements of the GNU Lesser General Public
008 * License, version 3.0 (the "License"). You may obtain a copy of the License at
009 *
010 *      http://www.gnu.org/licenses/lgpl.html
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
014 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
015 * License for the specific language governing permissions and limitations
016 * under the License.
017 */
018
019package org.tquadrat.foundation.function;
020
021import static org.apiguardian.api.API.Status.STABLE;
022
023import org.apiguardian.api.API;
024import org.tquadrat.foundation.annotation.ClassVersion;
025
026/**
027 *  <p>{@summary The definition for a getter method.}</p>
028 *  <p>This interface does <i>not</i> extend the otherwise very similar
029 *  interface
030 *  {@link java.util.function.Supplier}.</p>
031 *  <p>This is a
032 *  {@linkplain java.lang.FunctionalInterface functional interface}
033 *  whose functional method is
034 *  {@link #get()}.</p>
035 *
036 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
037 *  @version $Id: Getter.java 1031 2022-04-07 22:43:02Z tquadrat $
038 *  @since 0.0.5
039 *
040 *  @param  <T> The value type.
041 *
042 *  @UMLGraph.link
043 */
044@FunctionalInterface
045@ClassVersion( sourceVersion = "$Id: Getter.java 1031 2022-04-07 22:43:02Z tquadrat $" )
046@API( status = STABLE, since = "0.0.5" )
047public interface Getter<T>
048{
049        /*---------*\
050    ====** Methods **==========================================================
051        \*---------*/
052    /**
053     *  Returns a value.
054     *
055     *  @return The value.
056     */
057    public T get();
058}
059//  interface Getter
060
061/*
062 *  End of File
063 */