• Home
• org.smallmind
• smallmind-nutsnbolts
• 5.9.0
• source code
• Template.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.smallmind.nutsnbolts.command.template.Template Maven / Gradle / Ivy

/*
 * Copyright (c) 2007 through 2024 David Berkman
 *
 * This file is part of the SmallMind Code Project.
 *
 * The SmallMind Code Project is free software, you can redistribute
 * it and/or modify it under either, at your discretion...
 *
 * 1) The terms of GNU Affero General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at
 * your option) any later version.
 *
 * ...or...
 *
 * 2) The terms of the Apache License, Version 2.0.
 *
 * The SmallMind Code Project 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 or Apache License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * and the Apache License along with the SmallMind Code Project. If not, see
 *  or .
 *
 * Additional permission under the GNU Affero GPL version 3 section 7
 * ------------------------------------------------------------------
 * If you modify this Program, or any covered work, by linking or
 * combining it with other code, such other code is not for that reason
 * alone subject to any of the requirements of the GNU Affero GPL
 * version 3.
 */
package org.smallmind.nutsnbolts.command.template;

import java.io.InputStream;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;
import org.smallmind.nutsnbolts.command.CommandLineException;
import org.smallmind.nutsnbolts.command.sax.OptionsDocumentExtender;
import org.smallmind.nutsnbolts.lang.UnknownSwitchCaseException;
import org.smallmind.nutsnbolts.xml.SmallMindProtocolResolver;
import org.smallmind.nutsnbolts.xml.XMLEntityResolver;
import org.smallmind.nutsnbolts.xml.sax.ExtensibleSAXParser;
import org.xml.sax.InputSource;

public class Template {

  private static final XMLEntityResolver SMALL_MIND_ENTITY_RESOLVER = new XMLEntityResolver(SmallMindProtocolResolver.getInstance());

  private final LinkedList optionList = new LinkedList<>();
  private final HashSet optionSet = new HashSet<>();
  private final HashSet nameAndFlagSet = new HashSet<>();
  private final String shortName;

  public Template (Class entryClass) {

    shortName = entryClass.getSimpleName();
  }

  public Template (String shortName, Option... options)
    throws CommandLineException {

    this.shortName = shortName;

    addOptions(options);
  }

  public static Template createTemplate (Class entryClass)
    throws CommandLineException {

    Template template;
    OptionsDocumentExtender optionsDocumentExtender;
    InputStream optionsInputStream;

    template = new Template(entryClass);
    optionsDocumentExtender = new OptionsDocumentExtender(template);

    try {
      if ((optionsInputStream = Template.class.getClassLoader().getResourceAsStream(entryClass.getCanonicalName().replace('.', '/') + ".arguments.xml")) == null) {
        throw new CommandLineException("No arguments file found matching Class(%s)", entryClass.getCanonicalName());
      }
      ExtensibleSAXParser.parse(optionsDocumentExtender, new InputSource(optionsInputStream), SMALL_MIND_ENTITY_RESOLVER);
    } catch (Exception exception) {
      throw new CommandLineException(exception);
    }

    return template;
  }

  public String getShortName () {

    return shortName;
  }

  public synchronized List getRootOptionList () {

    return Collections.unmodifiableList(optionList);
  }

  public synchronized Set getOptionSet () {

    return Collections.unmodifiableSet(optionSet);
  }

  public synchronized void addOptions (Option... options)
    throws CommandLineException {

    addOptions(Arrays.asList(options));
  }

  public synchronized void addOptions (List optionList)
    throws CommandLineException {

    for (Option option : optionList) {

      if (((option.getName() == null) || option.getName().isEmpty()) && (option.getFlag() == null)) {
        throw new CommandLineException("All options must have either their 'name' or 'flag' set");
      } else {
        if ((option.getName() != null) && (!option.getName().isEmpty())) {
          if (nameAndFlagSet.contains(option.getName())) {
            throw new CommandLineException("All options must have a unique 'name', '%s' has been used", option.getName());
          } else {
            nameAndFlagSet.add(option.getName());
          }
        }
        if (option.getFlag() != null) {
          if (nameAndFlagSet.contains(option.getFlag().toString())) {
            throw new CommandLineException("All options must have a unique 'flag', '%s' has been used", option.getFlag().toString());
          } else {
            nameAndFlagSet.add(option.getFlag().toString());
          }
        }
      }

      optionSet.add(option);

      if (option.getChildren() != null) {
        addOptions(option.getChildren());
      }
    }

    this.optionList.addAll(optionList);
  }

  public synchronized String toString () {

    StringBuilder lineBuilder = new StringBuilder();

    stringifyOptions(lineBuilder, optionList);

    return lineBuilder.toString();
  }

  private void stringifyOptions (StringBuilder lineBuilder, List optionList) {

    boolean first = true;

    lineBuilder.append('{');
    for (Option option : optionList) {

      boolean named = false;

      if (!first) {
        lineBuilder.append(' ');
      }

      lineBuilder.append(option.isRequired() ? '[' : '<');

      if ((option.getName() != null) && (!option.getName().isEmpty())) {
        lineBuilder.append("--").append(option.getName());
        named = true;
      }
      if (option.getFlag() != null) {
        if (named) {
          lineBuilder.append(", ");
        }
        lineBuilder.append('-').append(option.getFlag());
      }

      switch (option.getArgument().getType()) {
        case NONE:
          break;
        case SINGLE:
          lineBuilder.append(' ').append(((SingleArgument)option.getArgument()).getDescription());
          break;
        case LIST:
          lineBuilder.append(' ').append(((ListArgument)option.getArgument()).getDescription()).append("...");
          break;
        case ENUMERATED:
          lineBuilder.append(" (");
          for (int index = 0; index < ((EnumeratedArgument)option.getArgument()).getValues().length; index++) {
            if (index > 0) {
              lineBuilder.append('|');
            }
            lineBuilder.append(((EnumeratedArgument)option.getArgument()).getValues()[index]);
          }
          lineBuilder.append(')');
        default:
          throw new UnknownSwitchCaseException(option.getArgument().getType().name());
      }

      if ((option.getChildren() != null) && (!option.getChildren().isEmpty())) {
        lineBuilder.append(' ');
        stringifyOptions(lineBuilder, option.getChildren());
      }

      lineBuilder.append(option.isRequired() ? ']' : '>');

      first = false;
    }
    lineBuilder.append('}');
  }
}