ParameterInfo.java

/*
 * Copyright (C) 2010 The Android Open Source Project
 *
 * 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 org.mule.devkit.doclet;

import com.google.clearsilver.jsilver.data.Data;

import java.util.Set;

public class ParameterInfo {
    public ParameterInfo(String name, String typeName, TypeInfo type, boolean isVarArg,
                         SourcePositionInfo position) {
        mName = name;
        mTypeName = typeName;
        mType = type;
        mIsVarArg = isVarArg;
        mPosition = position;
    }

    public ParameterInfo(String name, String typeName, TypeInfo type, boolean isVarArg,
                         SourcePositionInfo position, AnnotationInstanceInfo[] annotations) {
        mName = name;
        mTypeName = typeName;
        mType = type;
        mIsVarArg = isVarArg;
        mPosition = position;
        this.annotations = annotations;
    }

    AnnotationInstanceInfo[] annotations() {
        return this.annotations;
    }

    TypeInfo type() {
        return mType;
    }

    String name() {
        return mName;
    }

    String typeName() {
        return mTypeName;
    }

    SourcePositionInfo position() {
        return mPosition;
    }

    boolean isVarArg() {
        return mIsVarArg;
    }

    public void makeHDF(Data data, String base, boolean isLastVararg, Set<String> typeVariables) {
        data.setValue(base + ".name", this.name());
        if (mTypeName.contains("HttpCallback")) {
            data.setValue(base + ".attributeName", this.name() + "-flow-ref");
        } else {
            data.setValue(base + ".attributeName", this.name());
        }
        type().makeHDF(data, base + ".type", isLastVararg, typeVariables);
    }

    public static void makeHDF(Data data, String base, ParameterInfo[] params, boolean isVararg,
                               Set<String> typeVariables) {
        for (int i = 0; i < params.length; i++) {
            params[i].makeHDF(data, base + "." + i, isVararg && (i == params.length - 1), typeVariables);
        }
    }

    /**
     * Returns true if this parameter's dimension information agrees
     * with the represented callee's dimension information.
     */
    public boolean matchesDimension(String dimension, boolean varargs) {
        // foo(int... a) can be called as foo(int[] a).
        if (varargs) {
            dimension += "[]";
        }
        return mType.dimension().equals(dimension);
    }

    String mName;
    String mTypeName;
    TypeInfo mType;
    boolean mIsVarArg;
    SourcePositionInfo mPosition;
    AnnotationInstanceInfo[] annotations;
}