org.cristalise.kernel.scripting.Parameter Maven / Gradle / Ivy

Go to download
/**
 * This file is part of the CRISTAL-iSE kernel.
 * Copyright (c) 2001-2015 The CRISTAL Consortium. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation; either version 3 of the License, or (at
 * your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 *
 * http://www.fsf.org/licensing/licenses/lgpl.html
 */
package org.cristalise.kernel.scripting;

import lombok.Getter;
import lombok.Setter;

/**
 * Place holder for the Parameter details to be passed to the script.
 */
@Getter @Setter
public class Parameter {

    private String name;
    private Class type;
    private boolean initialised = false;

    public Parameter() {}

    public Parameter(String name) {
        this.name = name;
    }

    public Parameter(String name, Class type) {
        this.name = name;
        this.type = type;
    }

    /**
     * Method only provided for backward compability. Lombok would generate isInitialised() instead
     * @return if the Parameter was initialised or not
     */
    public boolean getInitialised() {
        return initialised;
    }

    /**
     * Sets the type paramater from the String. Method is needed to make Castor marshalling to work
     * 
     * FIXME: CASTOR MARSHALLING DOES NOT WORK YET
     * 
     * @param className the name of the Class specifying the type
     * @throws ClassNotFoundException class was not found
     */
    public void setTypeFromName(String className) throws ClassNotFoundException {
        type = Class.forName(className);
    }
}