org.apache.oodt.commons.option.handler.CmdLineOptionHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of oodt-commons Show documentation

Apache OODT Common Utilities Project

There is a newer version: 1.9.1

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


package org.apache.oodt.commons.option.handler;

//JDK imports
import java.util.List;

//OODT imports
import org.apache.oodt.commons.option.CmdLineOption;
import org.apache.oodt.commons.option.CmdLineOptionInstance;

//Spring imports
import org.apache.commons.lang.StringUtils;

/**
 * 
 * @author bfoster
 * @version $Revision$
 *
 * Describe your class here.
 */
public abstract class CmdLineOptionHandler {

    public String getOptionUsage(CmdLineOption option) {
        String argName = option.hasArgs() ? " <" + option.getOptionArgName()
                + ">" : "";
        String outputString = " -"
                + StringUtils.rightPad(option.getShortOption() + ",", 7) + "--"
                + StringUtils.rightPad((option.getLongOption() + argName), 49)
                + option.getDescription();
        if (!option.isRequired())
            outputString = "[" + outputString.substring(1) + "]";
        else if (option.getRequiredOptions().size() > 0)
            outputString = "{" + outputString.substring(1) + "}";
        return outputString;
    }

    public abstract void handleOption(CmdLineOption option, List values);

    public abstract String getCustomOptionUsage(CmdLineOption option);

    public abstract boolean affectsOption(CmdLineOptionInstance optionInstance);
    
}