beliefbase/storage/IStorage.java

Go to the documentation of this file.

/*
 * @cond LICENSE
 * ######################################################################################
 * # LGPL License                                                                       #
 * #                                                                                    #
 * # This file is part of the LightJason AgentSpeak(L++)                                #
 * # Copyright (c) 2015-19, LightJason (info@lightjason.org)                            #
 * # This program is free software: you can redistribute it and/or modify               #
 * # it under the terms of the GNU Lesser General Public License as                     #
 * # published by the Free Software Foundation, either version 3 of the                 #
 * # License, or (at your option) any later version.                                    #
 * #                                                                                    #
 * # This program is distributed in the hope that it will be useful,                    #
 * # but WITHOUT ANY WARRANTY; without even the implied warranty of                     #
 * # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                      #
 * # GNU Lesser General Public License for more details.                                #
 * #                                                                                    #
 * # You should have received a copy of the GNU Lesser General Public License           #
 * # along with this program. If not, see http://www.gnu.org/licenses/                  #
 * ######################################################################################
 * @endcond
 */

package org.lightjason.agentspeak.beliefbase.storage;

import org.lightjason.agentspeak.agent.IAgent;

import javax.annotation.Nonnull;
import java.util.Collection;
import java.util.stream.Stream;


public interface IStorage<N, M>
{

    @Nonnull
    Stream<N> streamMultiElements();

    @Nonnull
    Stream<M> streamSingleElements();

    boolean containsMultiElement( @Nonnull final String p_key );

    boolean containsSingleElement( @Nonnull final String p_key );

    boolean putMultiElement( @Nonnull final String p_key, final N p_value );

    boolean putSingleElement( @Nonnull final String p_key, final M p_value );

    boolean putSingleElementIfAbsent( @Nonnull final String p_key, final M p_value );

    boolean removeMultiElement( @Nonnull final String p_key, final N p_value );

    boolean removeSingleElement( @Nonnull final String p_key );

    M getSingleElement( @Nonnull final String p_key );

    M getSingleElementOrDefault( @Nonnull final String p_key, final M p_default );

    @Nonnull
    Collection<N> getMultiElement( @Nonnull final String p_key );

    void clear();

    boolean empty();

    @Nonnull
    IAgent<?> update( @Nonnull final IAgent<?> p_agent );

    int size();

}