org.kohsuke.args4j.spi.Getter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ImprovedArgs4J Show documentation

There is a newer version: 1.3.10

package org.kohsuke.args4j.spi;
import java.util.List;

import org.kohsuke.args4j.CmdLineException;
import org.openimaj.util.pair.IndependentPair;

/**
 * Abstraction of the value setter.
 *
 * @author Kohsuke Kawaguchi
 * @param  the type returned
 */
public interface Getter {
    /**
     * A {@link Getter} object has an implicit knowledge about the property it's setting,
     * and the instance of the option bean.
     * 
     * @return Get all values to the property of the option bean.
     * @throws CmdLineException 
     */
    List>> getStringValues() throws CmdLineException;

    /**
     * @return Gets the type of the underlying method/field.
     */
    Class getType();
    
    /**
     * @return Whether this setter is instrinsically multi-valued.
     */
    boolean isMultiValued();
    
    /**
     * @return The option name
     */
    public String getOptionName();
}