proposal/mutant/src/java/antcore/org/apache/ant/antcore/antlib/AntLibDefinition.java

/*
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2002 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Ant", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */
package org.apache.ant.antcore.antlib;

/**
 * This class represents a definition in an AntLibrary.
 *
 * @author <a href="mailto:conor@apache.org">Conor MacNeill</a>
 * @created 19 January 2002
 */
public class AntLibDefinition {
    /** The type of element being defined int his definition */
    private int definitionType;
    /** The default name for the defintion */
    private String definitionName;
    /** The classname associated with the object */
    private String definitionClassName;

    /**
     * Create a definition
     *
     * @param definitionName the default name of this definition when it is
     *      imported
     * @param definitionClassName the name of the class which is being
     *      defined
     * @param definitionType the type of the definition (taskdef, typedef,
     *      etc)
     */
    public AntLibDefinition(int definitionType, String definitionName,
                            String definitionClassName) {
        this.definitionName = definitionName;
        this.definitionType = definitionType;
        this.definitionClassName = definitionClassName;
    }

    /**
     * Get the type of this definition
     *
     * @return the definition type
     * @see AntLibrary for values
     */
    public int getDefinitionType() {
        return definitionType;
    }

    /**
     * Get the default name for this definition
     *
     * @return the default name for this definition
     */
    public String getDefinitionName() {
        return definitionName;
    }

    /**
     * Get the classname being defined
     *
     * @return the classname of this definition
     */
    public String getClassName() {
        return definitionClassName;
    }
}