com.tmarsteel.jcli.rule.XorOptionsRule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jcli Show documentation
A Java library for parsing and validating CLI arguments (and Strings formatted alike).
The newest version!
/* 
 * Copyright (C) 2015 Tobias Marstaller
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
package com.tmarsteel.jcli.rule;

import com.tmarsteel.jcli.Flag;
import com.tmarsteel.jcli.Identifiable;
import com.tmarsteel.jcli.validation.Validator;
import com.tmarsteel.jcli.validation.RuleNotMetException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

/**
 * Accepts input if exactly one of the given options/flags is set/specified. Use
 * this class instead of {@link XorRule} for a more user-friendly error message.
 * @author tmarsteel
 */
public class XorOptionsRule extends BaseRule
{
    protected String[] options;
    
    /**
     * @param options The options/flags/arguments to connect.
     */
    public XorOptionsRule(Identifiable... options)
    {
        this.options = new String[options.length];
        
        for (int i = 0;i < options.length;i++)
        {
            this.options[i] = options[i].getPrimaryIdentifier();
        }
    }

    /**
     * @param identifiers The options/flags/arguments to connect
     */
    public XorOptionsRule(String... identifiers) {
        this.options = Arrays.copyOf(identifiers, identifiers.length);
    }
    
    @Override
    public void validate(Validator intent, Validator.ValidatedInput params)
        throws RuleNotMetException
    {
        boolean prevSet = false;
        boolean anySet = false;
        
        for (String o:options)
        {
            if ((intent.knowsFlag(o) && params.isFlagSet(o))
             || (intent.knowsOption(o) && params.getOption(o) != null)
             || (intent.knowsArgument(o) && params.getArgument(o) != null)
            ) {
                anySet = true;
                
                if (prevSet)
                {
                    throw new RuleNotMetException(
                        errorMessage != null ? errorMessage :
                        prevSet + " and " + o + " cannot be set at the same time."
                    );
                }
                prevSet = true;
            }
            else
            {
                prevSet = false;
            }
        }
        
        if (!anySet)
        {
            throw new RuleNotMetException(
                errorMessage != null ? errorMessage :
                "Either one of these options/flags must be set."
            );
        }
    }
    
    @Override
    public String toString()
    {
        String str = "(Exactly one of these can be set at the same time:\n";
        for (String o:options)
        {
            str += o + "\n";
        }
        return str + ')';
    }
}