org.crsh.cmdline.matcher.CommandMatch Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2012 eXo Platform SAS.
 *
 * This 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 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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 software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.crsh.cmdline.matcher;

import org.crsh.cmdline.ArgumentDescriptor;
import org.crsh.cmdline.CommandDescriptor;
import org.crsh.cmdline.OptionDescriptor;
import org.crsh.cmdline.ParameterDescriptor;
import org.crsh.cmdline.binding.TypeBinding;

import java.io.IOException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;

public abstract class CommandMatch, B extends TypeBinding> {

  /** . */
  private final List> optionMatches;

  /** . */
  private final List> argumentMatches;

  /** . */
  private final String rest;

  public CommandMatch(List> optionMatches, List> argumentMatches, String rest) {
    this.optionMatches = optionMatches;
    this.argumentMatches = argumentMatches;
    this.rest = rest;
  }

  public abstract D getDescriptor();

  public final Object invoke(C command) throws CmdInvocationException, CmdSyntaxException {
    return invoke(Resolver.EMPTY, command);
  }

  public final Object invoke(Resolver context, C command) throws CmdInvocationException, CmdSyntaxException {

    //
    Set> unused = getParameters();
    Map, Object> parameterValues = new HashMap, Object>();

    //
    for (ParameterMatch parameterMatch : getParameterMatches()) {
      ParameterDescriptor parameter = parameterMatch.getParameter();
      if (!unused.remove(parameter)) {
        if (parameter instanceof ArgumentDescriptor) {
          ArgumentDescriptor argument = (ArgumentDescriptor)parameter;
          throw new CmdSyntaxException("Missing argument " + argument.getName());
        } else {
          OptionDescriptor option = (OptionDescriptor)parameter;
          throw new CmdSyntaxException("Missing option " + option.getNames());
        }
      }
      Object v = parameterMatch.computeValue();
      if (v != null) {
        parameterValues.put(parameter, v);
      }
    }

    //
    return doInvoke(context, command, parameterValues);
  }

  protected abstract Object doInvoke(Resolver context, C command, Map, Object> values) throws CmdInvocationException, CmdSyntaxException;

  public abstract Set> getParameters();

  public abstract List> getParameterMatches();

  public abstract void printMan(Appendable writer) throws IOException;

  public abstract void printUsage(Appendable writer) throws IOException;

  public List> getOptionMatches() {
    return optionMatches;
  }

  public List> getArgumentMatches() {
    return argumentMatches;
  }

  public String getRest() {
    return rest;
  }
}