org.lightjason.agentspeak.action.builtin.string.CRandom.java Source code

Introduction

Here is the source code for org.lightjason.agentspeak.action.builtin.string.CRandom.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.string;

import org.apache.commons.text.CharacterPredicate;
import org.apache.commons.text.RandomStringGenerator;
import org.lightjason.agentspeak.action.builtin.IBuiltinAction;
import org.lightjason.agentspeak.language.CCommon;
import org.lightjason.agentspeak.language.CRawTerm;
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;

/**
 * action to create random strings, with a definied length.
 * The first argument are the characters, that will be used to create the string,
 * all other arguments are numbers to present the length of the returning string
 * and the action never fails
 *
 * @code [A|B|C] = string/random( "abdefgXYZUI", 5, 3, 6 ); @endcode
 */
public final class CRandom extends IBuiltinAction {
    /**
     * serial id
     */
    private static final long serialVersionUID = -3114914702129124265L;

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

    @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) {
        final CharacterPredicate l_characters = p_char -> p_argument.get(0).<String>raw()
                .contains(new String(Character.toChars(p_char)));

        CCommon.flatten(p_argument).skip(1).map(i -> new RandomStringGenerator.Builder().filteredBy(l_characters)
                .build().generate(i.<Number>raw().intValue())).map(CRawTerm::from).forEach(p_return::add);

        return CFuzzyValue.from(true);
    }

}