IndexPicker.java

Go to the documentation of this file.

/*
    Synthia, a data structure generator
    Copyright (C) 2019-2020 Laboratoire d'informatique formelle
    Université du Québec à Chicoutimi, Canada
 
    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/>.
 */
package ca.uqac.lif.synthia;
 
/**
 * Picker for an integer from 0 to a fixed bound. This interface extends
 * <tt>Picker&lt;Integer&gt;</tt> by allowing the bound to be specified
 * and modified after the construction of the object, using
 * {@link #setInterval(int) setInterval()}.
 *  
 * @author Sylvain Hallé
 * @ingroup API
 */
public interface IndexPicker extends Picker<Integer>
{
    /**
     * Sets the range for the index picker
     * @param size The maximum value that can be picked
     * @return This picker
     */
    public IndexPicker setInterval(int size);
 
    /**
     * Creates a copy of the picker.
     * @param with_state If set to <tt>false</tt>, the returned copy is set to
     * the class' initial state (i.e. same thing as calling the picker's
     * constructor). If set to <tt>true</tt>, the returned copy is put into the
     * same internal state as the object it is copied from.
     * @return The copy of the picker
     */
    @Override
    public IndexPicker duplicate(boolean with_state);
}