org.lightjason.agentspeak.action.builtin.collection.list.CReverse.java Source code

Introduction

Here is the source code for org.lightjason.agentspeak.action.builtin.collection.list.CReverse.java

Source

/*
 * @cond LICENSE
 * ######################################################################################
 * # LGPL License                                                                       #
 * #                                                                                    #
 * # This file is part of the LightJason AgentSpeak(L++)                                #
 * # Copyright (c) 2015-17, 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.action.builtin.collection.list;

import com.google.common.collect.Lists;
import org.lightjason.agentspeak.action.builtin.IBuiltinAction;
import org.lightjason.agentspeak.language.CCommon;
import org.lightjason.agentspeak.language.ITerm;
import org.lightjason.agentspeak.language.execution.IContext;
import org.lightjason.agentspeak.language.fuzzy.CFuzzyValue;
import org.lightjason.agentspeak.language.fuzzy.IFuzzyValue;

import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import java.util.List;
import java.util.stream.Collectors;

/**
 * reverses a list.
 * All arguments of the action are lists and the action will remove
 * nested structures and reverse all elements in a single list,
 * the action fails never
 *
 * @code R = collection/list/reverse( L, [1,2], [3,4,[7,8]] ); @endcode
 */
public final class CReverse extends IBuiltinAction {
    /**
     * serial id
     */
    private static final long serialVersionUID = 2744303113340038007L;

    /**
     * ctor
     */
    public CReverse() {
        super(3);
    }

    @Nonnegative
    @Override
    public final int minimalArgumentNumber() {
        return 1;
    }

    @Nonnull
    @Override
    public final IFuzzyValue<Boolean> execute(final boolean p_parallel, @Nonnull final IContext p_context,
            @Nonnull final List<ITerm> p_argument, @Nonnull final List<ITerm> p_return) {
        // all arguments are list references
        p_return.addAll(Lists.reverse(CCommon.flatten(p_argument).collect(Collectors.toList())));
        return CFuzzyValue.from(true);
    }

}