IBeliefbase.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;

import org.lightjason.agentspeak.agent.IAgent;
import org.lightjason.agentspeak.beliefbase.view.IView;
import org.lightjason.agentspeak.language.ILiteral;
import org.lightjason.agentspeak.language.instantiable.plan.trigger.ITrigger;

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


public interface IBeliefbase extends IStructure
{
    IBeliefbase EMPY = new IBeliefbase()
    {

        @Override
        public final boolean empty()
        {
            return true;
        }

        @Override
        public final int size()
        {
            return 0;
        }

        @Nonnull
        @Override
        public final IAgent<?> update( @Nonnull final IAgent<?> p_agent )
        {
            return p_agent;
        }

        @Nonnull
        @Override
        public final Stream<ITrigger> trigger( @Nonnull final IView p_view )
        {
            return Stream.empty();
        }

        @Nonnull
        @Override
        public final Stream<ILiteral> streamLiteral()
        {
            return Stream.empty();
        }

        @Nonnull
        @Override
        public final Stream<IView> streamView()
        {
            return Stream.empty();
        }

        @Nonnull
        @Override
        public final IBeliefbase clear()
        {
            return this;
        }

        @Nonnull
        @Override
        public final ILiteral add( @Nonnull final ILiteral p_literal )
        {
            return p_literal;
        }

        @Nonnull
        @Override
        public final IView add( @Nonnull final IView p_view )
        {
            return p_view;
        }

        @Nonnull
        @Override
        public final ILiteral remove( @Nonnull final ILiteral p_literal )
        {
            return p_literal;
        }

        @Nonnull
        @Override
        public final IView remove( @Nonnull final IView p_view )
        {
            return p_view;
        }

        @Override
        public final boolean containsLiteral( @Nonnull final String p_key )
        {
            return false;
        }

        @Override
        public final boolean containsView( @Nonnull final String p_key )
        {
            return false;
        }

        @Nullable
        @Override
        public final IView view( @Nonnull final String p_key )
        {
            return IView.EMPTY;
        }

        @Nonnull
        @Override
        public final Collection<ILiteral> literal( @Nonnull final String p_key )
        {
            return Collections.emptySet();
        }

        @Nullable
        @Override
        public final IView viewOrDefault( @Nonnull final String p_key, @Nullable final IView p_default )
        {
            return p_default;
        }

        @Nonnull
        @Override
        public final IView create( @Nonnull final String p_name )
        {
            return IView.EMPTY;
        }

        @Nonnull
        @Override
        public final IView create( @Nonnull final String p_name, @Nullable final IView p_parent
        )
        {
            return IView.EMPTY;
        }

    };

    @Nonnull
    Stream<ITrigger> trigger( @Nonnull final IView p_view );



    @Nonnull
    Stream<ILiteral> streamLiteral();

    @Nonnull
    Stream<IView> streamView();



    @Nonnull
    IBeliefbase clear();



    @Nonnull
    ILiteral add( @Nonnull final ILiteral p_literal );

    @Nonnull
    IView add( @Nonnull final IView p_view );



    @Nonnull
    ILiteral remove( @Nonnull final ILiteral p_literal );

    @Nonnull
    IView remove( @Nonnull final IView p_view );



    boolean containsLiteral( @Nonnull final String p_key );

    boolean containsView( @Nonnull final String p_key );



    @Nullable
    IView view( @Nonnull final String p_key );

    @Nonnull
    Collection<ILiteral> literal( @Nonnull final String p_key );

    @Nullable
    IView viewOrDefault( @Nonnull final String p_key, @Nullable final IView p_default );



    @Nonnull
    IView create( @Nonnull final String p_name );

    @Nonnull
    IView create( @Nonnull final String p_name, @Nullable final IView p_parent );

}