com.martiansoftware.jsap.DefaultSource Maven / Gradle / Ivy

Go to download

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

A porting of JSAP to java 1.7+.

The newest version!

/*
 * Copyright (c) 2002-2004, Martian Software, Inc.
 * This file is made available under the LGPL as described in the accompanying
 * LICENSE.TXT file.
 */

package com.martiansoftware.jsap;

/**
 * An interface describing an object as being able to produce a set of default
 * values.
 * @author Marty Lamb
 * @see com.martiansoftware.jsap.Defaults
 */
public interface DefaultSource {

    /**
     * Returns a set of default values given the configuration described by the
     * specified IDMap.  Any encountered exceptions are stored in the specified
     * JSAPResult.
     * @param idMap an IDMap containing JSAP configuration information.
     * @param exceptionMap the ExceptionMap object within which any Exceptions
     * will be returned.
     * @return a set of default values given the configuration described by the
     * specified IDMap.
     * @see com.martiansoftware.jsap.ExceptionMap#addException(String,Exception)
     */
    Defaults getDefaults(IDMap idMap, ExceptionMap exceptionMap);

}