ParserParameter.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2020 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the 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.
 *
 * 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package org.turro.parser;
 
import java.util.HashSet;
import org.turro.util.CompareUtil;
 
public class ParserParameter implements Comparable<ParserParameter> {
 
  protected String name;
  protected boolean optional;
  protected int order;
  protected boolean commaSeparated;
  protected HashSet<String> possibleValues = new HashSet<>();
  protected String defaultValue;
 
  public ParserParameter(String name, boolean optional, String defaultValue, int order) {
    this(name, optional, defaultValue, order, false);
  }
  
  public ParserParameter(String name, boolean optional, String defaultValue, int order, boolean commaSeparated) {
    this.name = name;
    this.optional = optional;
    this.defaultValue = defaultValue;
    this.order = order;
    this.commaSeparated = commaSeparated;
  }
 
  public String getName() {
    return name;
  }
 
  public boolean isOptional() {
    return optional;
  }
 
  public String getDefaultValue() {
    return defaultValue;
  }
 
  public int getOrder() {
    return order;
  }
 
  public boolean isCommaSeparated() {
    return commaSeparated;
  }
 
  public HashSet<String> getPossibleValues() {
    return possibleValues;
  }
  
  public void addPossibleValue(String value) {
    possibleValues.add(value);
  }
  
  @Override
  public int compareTo(ParserParameter o) {
    int result = CompareUtil.compare(order, o.order);
    if(result == 0) {
      result = CompareUtil.compare(name, o.name);
    }
    if(result == 0) {
      result = CompareUtil.compare(optional, o.optional);
    }
    return result;
  }
 
}