- /*
- * $Header: /home/cvspublic/jakarta-commons/modeler/src/java/org/apache/commons/modeler/ParameterInfo.java,v 1.5 2003/07/20 07:35:12 ggregory Exp $
- * $Revision: 1.5 $
- * $Date: 2003/07/20 07:35:12 $
- *
- * ====================================================================
- *
- * The Apache Software License, Version 1.1
- *
- * Copyright (c) 1999 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", "Commons", 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/>.
- *
- * [Additional notices, if required by prior licensing conditions]
- *
- */
-
-
- package org.apache.commons.modeler;
-
-
- import java.io.Serializable;
-
- import javax.management.MBeanParameterInfo;
-
-
- /**
- * <p>Internal configuration information for a <code>Parameter</code>
- * descriptor.</p>
- *
- * @author Craig R. McClanahan
- * @version $Revision: 1.5 $ $Date: 2003/07/20 07:35:12 $
- */
-
- public class ParameterInfo extends FeatureInfo implements Serializable {
- static final long serialVersionUID = 2222796006787664020L;
- // ----------------------------------------------------------- Constructors
-
-
- /**
- * Standard zero-arguments constructor.
- */
- public ParameterInfo() {
-
- super();
-
- }
-
-
- /**
- * Special constructor for setting up parameters programatically.
- *
- * @param name Name of this parameter
- * @param type Java class of this parameter
- * @param description Description of this parameter
- */
- public ParameterInfo(String name, String type, String description) {
-
- super();
- setName(name);
- setType(type);
- setDescription(description);
-
- }
-
-
- // ----------------------------------------------------- Instance Variables
-
-
- /**
- * The <code>MBeanParameterInfo</code> object that corresponds
- * to this <code>ParameterInfo</code> instance.
- */
- transient MBeanParameterInfo info = null;
- protected String type = null;
-
- // ------------------------------------------------------------- Properties
-
-
- /**
- * Override the <code>description</code> property setter.
- *
- * @param description The new description
- */
- public void setDescription(String description) {
- super.setDescription(description);
- this.info = null;
- }
-
-
- /**
- * Override the <code>name</code> property setter.
- *
- * @param name The new name
- */
- public void setName(String name) {
- super.setName(name);
- this.info = null;
- }
-
-
- /**
- * The fully qualified Java class name of this parameter.
- */
- public String getType() {
- return (this.type);
- }
-
- public void setType(String type) {
- this.type = type;
- this.info = null;
- }
-
-
- // --------------------------------------------------------- Public Methods
-
-
- /**
- * Create and return a <code>MBeanParameterInfo</code> object that
- * corresponds to the parameter described by this instance.
- */
- public MBeanParameterInfo createParameterInfo() {
-
- // Return our cached information (if any)
- if (info != null)
- return (info);
-
- // Create and return a new information object
- info = new MBeanParameterInfo
- (getName(), getType(), getDescription());
- return (info);
-
- }
-
-
- /**
- * Return a string representation of this parameter descriptor.
- */
- public String toString() {
-
- StringBuffer sb = new StringBuffer("ParameterInfo[");
- sb.append("name=");
- sb.append(name);
- sb.append(", description=");
- sb.append(description);
- sb.append(", type=");
- sb.append(type);
- sb.append("]");
- return (sb.toString());
-
- }
- }