webcommon/javascript2.jsdoc/src/org/netbeans/modules/javascript2/jsdoc/model/ParameterElement.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.netbeans.modules.javascript2.jsdoc.model;

import java.util.List;
import org.netbeans.modules.javascript2.types.api.Type;

/**
 * Represents base parameter element class with optional parameter type and description.
 *
 * @author Martin Fousek <marfous@netbeans.org>
 */
public abstract class ParameterElement extends JsDocElementImpl {

    private final List<Type> paramTypes;
    private final String paramDescription;

    public ParameterElement(JsDocElementType type, List<Type> paramTypes, String paramDescription) {
        super(type);
        this.paramTypes = paramTypes;
        this.paramDescription = paramDescription;
    }

    /**
     * Gets the description of the parameter.
     * @return parameter description
     */
    public String getParamDescription() {
        return paramDescription;
    }

    /**
     * Gets the parameter types.
     * @return parameter types
     */
    public List<Type> getParamTypes() {
        return paramTypes;
    }

}