DocMethodParameter.java

/**
 * Copyright 2011-2017 Asakusa Framework Team.
 *
 * Licensed 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 com.asakusafw.utils.java.model.syntax;


/**
 * An interface which represents formal parameters in {@link DocMethod}.
 */
public interface DocMethodParameter
        extends Model {

    /**
     * Returns the parameter type.
     * @return the parameter type
     */
    Type getType();

    /**
     * Returns the parameter name.
     * @return the parameter name, or {@code null} if it is not specified
     */
    SimpleName getName();

    /**
     * Returns whether this parameter is variable arity or not.
     * @return {@code true} if this parameter is variable arity, otherwise {@code false}
     */
    boolean isVariableArity();
}