IView.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.view;

import org.lightjason.agentspeak.agent.IAgent;
import org.lightjason.agentspeak.beliefbase.IBeliefbase;
import org.lightjason.agentspeak.beliefbase.IStructure;
import org.lightjason.agentspeak.common.IPath;
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.stream.Stream;


public interface IView extends IStructure
{
    IView EMPTY = new IView()
    {
        @Nonnull
        @Override
        @SafeVarargs
        @SuppressWarnings( "varargs" )
        public final Stream<IView> walk( @Nonnull final IPath p_path, @Nullable final IViewGenerator... p_generator )
        {
            return Stream.empty();
        }

        @Nonnull
        @Override
        public final IView generate( @Nonnull final IViewGenerator p_generator, @Nonnull final IPath... p_paths )
        {
            return this;
        }

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

        @Nonnull
        @Override
        public final IBeliefbase beliefbase()
        {
            return IBeliefbase.EMPY;
        }

        @Nonnull
        @Override
        public final IPath path()
        {
            return IPath.EMPTY;
        }

        @Nonnull
        @Override
        public final String name()
        {
            return "";
        }

        @Nullable
        @Override
        public final IView parent()
        {
            return null;
        }

        @Override
        public final boolean hasParent()
        {
            return false;
        }

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

        @Nonnull
        @Override
        public final Stream<ILiteral> stream( @Nullable final IPath... p_path )
        {
            return Stream.empty();
        }

        @Nonnull
        @Override
        public final Stream<ILiteral> stream( final boolean p_negated, @Nullable final IPath... p_path )
        {
            return Stream.empty();
        }

        @Nonnull
        @Override
        public final IView clear( @Nullable final IPath... p_path )
        {
            return this;
        }

        @Nonnull
        @Override
        public final IView add( @Nonnull final Stream<ILiteral> p_literal )
        {
            return this;
        }

        @Nonnull
        @Override
        @SuppressWarnings( "varargs" )
        public final IView add( @Nonnull final IView... p_view )
        {
            return this;
        }

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

        @Nonnull
        @Override
        public final IView remove( @Nonnull final Stream<ILiteral> p_literal )
        {
            return this;
        }

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

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

        @Override
        public final boolean containsLiteral( @Nonnull final IPath p_path )
        {
            return false;
        }

        @Override
        public final boolean containsView( @Nonnull final IPath p_path )
        {
            return false;
        }

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

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

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

    };


    @Nonnull
    @SuppressWarnings( "unchecked" )
    Stream<IView> walk( @Nonnull final IPath p_path, @Nullable final IViewGenerator... p_generator );

    @Nonnull
    IView generate( @Nonnull final IViewGenerator p_generator, @Nonnull final IPath... p_paths );

    @Nonnull
    Stream<IView> root();

    @Nonnull
    IBeliefbase beliefbase();

    @Nonnull
    IPath path();

    @Nonnull
    String name();

    @Nullable
    IView parent();

    boolean hasParent();



    @Nonnull
    Stream<ITrigger> trigger();



    @Nonnull
    Stream<ILiteral> stream( @Nullable final IPath... p_path );

    @Nonnull
    Stream<ILiteral> stream( final boolean p_negated, @Nullable final IPath... p_path );



    @Nonnull
    IView clear( @Nullable final IPath... p_path );



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

    @Nonnull
    IView add( @Nonnull final Stream<ILiteral> p_literal );

    @Nonnull
    @SuppressWarnings( "unchecked" )
    IView add( @Nonnull final IView... p_view );

    @Nonnull
    IView remove( @Nonnull final Stream<ILiteral> p_literal );

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

    @Nonnull
    @SuppressWarnings( "unchecked" )
    IView remove( @Nonnull final IView... p_view );



    boolean containsLiteral( @Nonnull final IPath p_path );

    boolean containsView( @Nonnull final IPath p_path );

}